API specification

Version 6.0

This document details all the functions for integrating with Street Manager via the latest version of the API. See the ‘Versions and Changes’ section for more details on previous versions. The documentation for the stable version of the API is available here.


GeoJSON API Resource Guide

This API returns data in the form of GeoJSON using BNG (British National Grid EPSG:27700) as the Coordinate Reference System, as per Street Works industry standard.

Get works endpoint

GET /works

This endpoint takes min and max easting and northing values to select all works within a bounding box. The works selected can be optionally filtered using the start and end date params.

Get activities endpoint

GET /activities

This endpoint takes min and max easting and northing values to select all activities within a bounding box. The activities selected can be optionally filtered using the start and end date params.

Get forward plans endpoint

GET /forward-plans

This endpoint takes min and max easting and northing values to select all raised forward plans within a bounding box. The forward plans selected can be optionally filtered using the start and end date params.

Get HS2 Act Limits endpoint

GET /hs2-act-limits

This endpoint takes min and max easting and northing values to select all HS2 act limits within a bounding box.

Get Section 58s endpoint

GET /section-58s

This endpoint takes min and max easting and northing values to select all proposed and in-force Section 58s within a bounding box. Start and end date filters can also be provided.

Get Ancillary Informations endpoint

GET /ancillary-informations

This endpoint takes min and max easting and northing values to select all added Ancillary Informations within a bounding box. Start and end date filters can also be provided.

Get Material Classifications endpoint

GET /material-classifications

This endpoint takes min and max easting and northing values to select all added Material Classifications within a bounding box. Sample date to and from date, USRN, and Classification type filters can also be provided.

Get Potential Clashes endpoint

GET /potential-clashes

This endpoint takes a USRN and work start and end dates to return a list of other works that are taking place on the USRN within the given dates.

Get Potential Collaborations and Clashes endpoint

GET /potential-collaborations-and-clashes

This endpoint takes easting and northing coordinates, work start and end date, and returns nearby works that are open to collaboration occurring within the given date range. This endpoint optionally accepts a USRN. If provided it also returns works that are taking place on that USRN within the given dates.