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.

Street Lookup API Resource Guide

The Street Lookup API provides a means of querying the NSG dataset. The endpoints described below return a filtered, formatted subset of the data available within the NSG dataset.

USRNs which are marked as Closed (street state 4) or Addressing Purposes Only (street state 5) are excluded from results. Street Manager also filters results based on the reinstatement type code, as described below.

Reinstatement type codes

Below is a list of Reinstatement type codes currently supported by Street Manager, these codes correspond to the reinstatement_type_codes found in the NSG specification:

  1. 0 - This is currently mapped to reinstatement type code 5 for backward compatibility purposes, but this will be removed in a future version of Street Manager so we recommend providing reinstatement type code 5 (see below)
  2. 1 - Carriageway type 1 (10 to 30 MSA)
  3. 2 - Carriageway type 2 (2.5 to 10 MSA)
  4. 3 - Carriageway type 3 (0.5 to 2.5 MSA)
  5. 4 - Carriageway type 4 (up to 0.5 MSA)
  6. 5 - Carriageway type 0 (30 to 125 MSA)
  7. 6 - High Duty Footway
  8. 7 - High Amenity Footway
  9. 8 - Other Footways
  10. 9 - Private Street – No definition information held by Street Authority
  11. 10 - Carriageway type 6 (over 125 MSA)

The remaining reinstatement type codes (11 - Street maintained by another Highway Authority and 12 Street outside scope of EToN) are not supported by Street Manager. USRNs with these codes are not returned by the endpoints below.

Get streets endpoint (coordinates)

POST /nsg/streets/search

Returns NSG data within 25 meters of each coordinate pair point provided. The information returned can be used to populate a PermitCreateRequest or a WorkCreateRequest. The additional_special_designations_response property values are returned in the format defined by the NSG specification.

Get streets endpoint (USRN)

GET /nsg/streets/{usrn}

Returns NSG data based on a USRN. The information returned can be used to populate a PermitCreateRequest or a WorkCreateRequest. The additional_special_designations_response property values are returned in the format defined by the NSG specification.

Get nsg search (Available in public beta)

GET /nsg/search

Returns street data based on a query search across the NSG street_descriptor, locality_name, town_name and administrative_area.