Skip to main content

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
FieldDescription
fiscal_yearUK fiscal year (April to March)
permitsTotal number of permits issued
distinct_promotersNumber of unique promoters
active_monthsMonths with active works
emergencyEmergency permit count
signalsTemporary traffic signals count
closuresRoad closure count
collaborativeCollaborative works count
avg_duration_daysAverage permit duration in days
total_days_of_worksTotal days of works across all permits
top_5_promotersTop 5 promoters by permit volume (promoter name → count)
top_5_emergencyTop 5 promoters by emergency permits (promoter name → count)
top_5_new_connectionsTop 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
FieldDescription
usrnUnique Street Reference Number
street_nameName of the street
highway_authority_swa_codeSWA code for the highway authority
highway_authorityName of the highway authority
promoter_swa_codeSWA code of the promoter
promoter_organisationName of the promoter organisation
total_permitsTotal completed permits
emergency_permitsNumber of emergency permits
collaborative_permitsNumber of collaborative permits
signals_permitsPermits involving temporary traffic signals
closures_permitsPermits involving road closures
avg_duration_daysAverage permit duration in days
total_days_of_worksTotal days of works across all permits
first_work_dateDate of the earliest completed permit
last_work_dateDate of the most recent completed permit
work_categoriesPermit counts broken down by work category
activity_typesPermit 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
FieldDescription
usrnUnique Street Reference Number
highway_authority_swa_codeSWA code for the highway authority
highway_authorityName of the highway authority
street_nameName of the street
promotersList 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"
]
}