Skip to main content

Endpoints

All endpoints require an X-API-Key header for authentication.

GET /usrn-history​

Permit history for a USRN, broken down by fiscal year.

Potential use cases:

  • Compare promoter activity across fiscal years to spot trends in works or traffic management types

Response fields:

fiscal_year — UK fiscal year (April to March)
permits — Total number of permits issued
distinct_promoters — Number of unique promoters
active_months — Months with active works
emergency — Emergency permit count
signals — Temporary traffic signals count
closures — Road closure count
collaborative — Collaborative works count
avg_duration_days — Average permit duration in days
total_days_of_works — Total days of works across all permits
top_5_promoters — Top 5 promoters by permit volume
top_5_emergency — Top 5 promoters by emergency permits
top_5_new_connections — Top 5 promoters by new connections
licensing — Open Government Licence v3.0 (Department for Transport)

{
  "usrn": "string",
  "fiscal_years": [
    {
      "fiscal_year": "FY 2024/25",
      "permits": 0,
      "distinct_promoters": 0,
      "active_months": 0,
      "emergency": 0,
      "signals": 0,
      "closures": 0,
      "collaborative": 0,
      "avg_duration_days": 0,
      "total_days_of_works": 0,
      "top_5_promoters": { "BT": 12, "ELECTRICITY NORTH WEST LIMITED": 5 },
      "top_5_emergency": { "BT": 3 },
      "top_5_new_connections": null
    }
  ],
  "licensing": "Contains Street Manager data © Department for Transport, licensed under the Open Government Licence v3.0."
}

Data source: OS Open USRNs from Ordnance Survey and Street Manager data from the Department for Transport, both available under the Open Government Licence v3.0.

GET /promoter-usrn-activity​

Aggregated street works activity for a specific promoter on a given USRN.

Query parameters:

  • usrn — Unique Street Reference Number (numeric)
  • promoter_swa_code — Promoter SWA code

Potential use cases:

  • Understand how active a specific utility company is on a given street

Response fields:

usrn — Unique Street Reference Number
street_name — Name of the street
highway_authority_swa_code — SWA code for the highway authority
highway_authority — Name of the highway authority
promoter_swa_code — SWA code of the promoter
promoter_organisation — Name of the promoter organisation
total_permits — Total completed permits
emergency_permits — Number of emergency permits
collaborative_permits — Number of collaborative permits
signals_permits — Permits involving temporary traffic signals
closures_permits — Permits involving road closures
avg_duration_days — Average permit duration in days
total_days_of_works — Total days of works across all permits
first_work_date — Date of the earliest completed permit
last_work_date — Date of the most recent completed permit
work_categories — Permit counts broken down by work category
activity_types — Permit counts broken down by activity type
licensing — Open Government Licence v3.0 (Department for Transport)

{
  "usrn": "string",
  "street_name": "string",
  "highway_authority_swa_code": "string",
  "highway_authority": "string",
  "promoter_swa_code": "string",
  "promoter_organisation": "string",
  "total_permits": 0,
  "emergency_permits": 0,
  "collaborative_permits": 0,
  "signals_permits": 0,
  "closures_permits": 0,
  "avg_duration_days": 0.0,
  "total_days_of_works": 0,
  "first_work_date": "2020-04-01",
  "last_work_date": "2024-11-15",
  "work_categories": { "Minor": 10, "Standard": 3 },
  "activity_types": { "New": 8, "Remedial": 5 },
  "licensing": "Contains Street Manager data © Department for Transport, licensed under the Open Government Licence v3.0."
}

Data source: OS Open USRNs from Ordnance Survey and Street Manager data from the Department for Transport, both available under the Open Government Licence v3.0.

GET /usrn-info​

Street information and all known promoters for a USRN.

Potential use cases:

  • Quickly identify which utility companies and authorities are active on a given street

Response fields:

usrn — Unique Street Reference Number
highway_authority_swa_code — SWA code for the highway authority
highway_authority — Name of the highway authority
street_name — Name of the street
promoters — List of all promoters that have worked on this street
licensing — Open Government Licence v3.0 (Department for Transport)

{
  "usrn": "string",
  "highway_authority_swa_code": "string",
  "highway_authority": "string",
  "street_name": "string",
  "promoters": [
    "BT",
    "ELECTRICITY NORTH WEST LIMITED (NORWEB)",
    "WIGAN METROPOLITAN BOROUGH COUNCIL"
  ],
  "licensing": "Contains Street Manager data © Department for Transport, licensed under the Open Government Licence v3.0."
}

Data source: OS Open USRNs from Ordnance Survey and Street Manager data from the Department for Transport, both available under the Open Government Licence v3.0.

GET /usrn-soil-attribution​

Soil attribution data from the National Soil Dataset matched to a USRN.

Potential use cases:

  • Understand ground conditions on a street before planning works
  • Draw possible relationships between asset health and reinstatements

Response fields:

usrn — Unique Street Reference Number
geology — Distinct geology classifications intersecting this USRN
soilscape — Distinct soilscape types intersecting this USRN
drainage — Distinct drainage classes intersecting this USRN
drains_to — Distinct drainage destinations intersecting this USRN
licensing — LandIS Open Licence (Cranfield University)

{
  "usrn": "string",
  "geology": ["Loamy and sandy soils with naturally high groundwater"],
  "soilscape": ["Freely draining slightly acid loamy soils"],
  "drainage": ["Well drained"],
  "drains_to": ["River"],
  "licensing": "LandIS Open Licence - Cranfield University"
}

Data source: National Soil Dataset from Cranfield University's LandIS Portal, available under the LandIS Open Licence.

GET /usrn-naptan​

NaPTAN bus stop data matched to a USRN.

Potential use cases:

  • Identify whether a street has nearby bus stops before planning works
  • Assess public transport impact of permits on a given street

Response fields:

usrn — Unique Street Reference Number
street_type — Whether the USRN is a regular road or motorway
atco_codes — List of ATCO codes for matched bus stops
naptan_codes — List of NaPTAN codes for matched bus stops
stop_count — Total number of bus stops matched to this USRN
licensing — Open Government Licence v3.0 (Department for Transport)

{
  "usrn": "string",
  "street_type": "Regular Road",
  "atco_codes": ["010A0001", "010A0002"],
  "naptan_codes": ["0500SW", "0500SX"],
  "stop_count": 2,
  "licensing": "Contains NaPTAN data © Department for Transport, licensed under the Open Government Licence v3.0."
}

Data source: National Public Transport Access Nodes (NaPTAN), published by the Department for Transport. Bus stops are matched to USRNs within a 10m buffer.

GET /usrn-bods​

Active bus services and stops on a USRN, derived from the Bus Open Data Service (BODS).

Potential use cases:

  • Identify which registered bus services could be disrupted by street works on a given street
  • Cross-reference permit data with bus route coverage to assess transport impact
  • Map which agencies operate services along a specific USRN

Response fields:

usrn — Unique Street Reference Number
street_type — The type of USRN (e.g. "Officially Described Street")
stop_count — Total number of active bus stops on this USRN
naptan_codes — List of NaPTAN codes for stops on this USRN
atco_codes — List of ATCO codes for stops on this USRN
route_ids — Internal BODS route IDs for services on this USRN
route_short_names — Short names of bus routes (e.g. "42", "X10")
agency_names — Names of operating agencies
agency_nocs — National Operator Codes (NOCs) for each agency
active_route_count — Number of distinct active routes on this USRN
licensing — Open Government Licence v3.0 (Department for Transport)

{
  "usrn": "string",
  "street_type": "Designated Street Name",
  "stop_count": 4,
  "naptan_codes": ["0500SW001", "0500SW002"],
  "atco_codes": ["010A0001", "010A0002"],
  "route_ids": [1012, 1087],
  "route_short_names": ["42", "X10"],
  "agency_names": ["Arriva North West"],
  "agency_nocs": ["ANWE"],
  "active_route_count": 2,
  "licensing": "Contains BODS data © Department for Transport, licensed under the Open Government Licence v3.0. https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/ | Contains OS data © Crown copyright and database right 2025, licensed under the Open Government Licence v3.0. https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/"
}

Data source: Bus Open Data Service (BODS), published by the Department for Transport. Bus services are matched to USRNs via NaPTAN stop locations.

GET /uprns-per-usrn​

UPRN count for a USRN, derived from OS Linked Identifiers.

Potential use cases:

  • Assess community impact of works on streets with high property counts
  • Prioritise communications for permits affecting densely populated streets

Response fields:

usrn — Unique Street Reference Number
uprn_count — Number of Unique Property Reference Numbers linked to this USRN
licensing — Open Government Licence v3.0 (Ordnance Survey)

{
  "usrn": "string",
  "uprn_count": 142,
  "licensing": "Contains data from the Open USRN dataset and Open Linked Identifiers dataset, licensed under the Open Government Licence v3.0."
}

Data source: OS Linked Identifiers from Ordnance Survey, available under the Open Government Licence v3.0.