Endpoints
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
| Field | Description |
|---|---|
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 (promoter name → count) |
top_5_emergency | Top 5 promoters by emergency permits (promoter name → count) |
top_5_new_connections | Top 5 promoters by new connections (promoter name → count) |
{
"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
}
]
}
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
| Field | Description |
|---|---|
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 |
{
"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 }
}
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
| Field | Description |
|---|---|
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 |
{
"usrn": "string",
"highway_authority_swa_code": "string",
"highway_authority": "string",
"street_name": "string",
"promoters": [
"BT",
"ELECTRICITY NORTH WEST LIMITED (NORWEB)",
"WIGAN METROPOLITAN BOROUGH COUNCIL"
]
}