Internal API

This API is designed for internal use within Network Rail. It uses a simple authentication mechanism that does not link to a specific "user" within the system. It was created in response to a request to report into Power BI.

Base URL

https://nrsdb.uk/api/v1

Authentication

Registered users of the API will be issued with a key - all requests (other than this help URL) must pass this key as a Bearer token

Sample Code

Sample GET request

  const params = new URLSearchParams();
  params.append('property', value);

  const response = await fetch(`${url}?${params}`, {
    'credentials': 'same-origin',
    'headers': {
      'Authorization': `Bearer ${token}`
      'Accept': 'application/json',
      'Content-Type': 'application/json',
      'X-Requested-With': 'XMLHttpRequest'
    },
    'method': 'GET'
  });

Sample POST from a form element

const response = await fetch(url, {
  'body': formData,
  'credentials': 'same-origin',
  'headers': {
    'Authorization': `Bearer ${token}`
  },
  'method': 'POST'
});

NOTE: in my experience it is best not to set the 'Content-Type' header here

Endpoints

Routes

E.g. Anglia, North-West, Wales

Delivery Units

Sample Response

{
  "data": {
    "name": "Ipswich",
    "routeId": 2,
  }
}

ELRs

• /elrs - returns all of the ELRs known to the system
• /elr/{elrId} - returns the details for a specific ELR

Sample Response

{
  "data": {
    "elrs": [
      {
        "id": 1,
        "elrcode": "AAV",
        "elrdescription": "ASCOT JN - ASH VALE JN",
        "active": true
      },
      {
        "id": 2,
        "elrcode": "ABD",
        "elrdescription": "ABERDARE  BRANCH",
        "active": true
      },
      ...
    ]
  }
}

 

Locations

Autumn Inspections

• /autumn/locations/{routeId} - return all Locations to be inspected on the given route
• /autumn/inspections - returns all of the inspections
• /autumn/inspections/route/{routeId} - returns all inspections for a given route

  {
  "id": 33,
  "inspectionDate": "2025-06-09T23:55:39+01:00",
  "locationId": 236,
  "location": {
      "id": 236,
      "location": "Falconwood",
      "locationClass": "Platform",
      "routeId": 8,
      "ownerId": 33,
      "elrId": 81,
      "trackId": 1100,
      "track": "",
      "start": 827,
      "end": 827,
      "frequency": 1,
      "active": true,
      "inspections": []
  },
  "inspectorId": 3,
  "inspector": null,
  "weather": {
      "precipitation": 3,
      "wind": 2,
      "overhead": 2,
      "ground": 2
  },
  "rail_condition": "dry",
  "evaluation": 0,
  "action_taken": "",
  "comments": "",
  "images": []
  }

ESRs

• /esrs
• /esrs/route/{routeId} - returns ESRs for a given route

GIS

• /gis/nearest/{lng}/{lat} -- returns the nearest mileage marker (ELR, track, miles, chains)
• /gis/w3w/{elr}?trackId=1100&miles=1&chains=0 -- returns the W3W code for the marker at the given location, trackId is optional, chains defaults to 0 if not given

Error Handling

Power BI