API Reference

National Rail API Integration

GET `/api/getServices`

Retrieves live train service information for a specified UK railway station from the National Rail Darwin API.

Description

Fetches real-time departure and arrival information for trains at a given station using the station's CRS code. This endpoint is deployed as a Cloudflare Worker function.

Parameters

Name	Type	Required	Description
`crs`	string	Yes	Three-letter CRS (Computer Reservation System) code for the station (e.g., "KGX" for King's Cross)
`numRows`	number	No	Number of services to return (default varies)
`timeOffset`	number	No	Time offset in minutes from current time
`timeWindow`	number	No	Time window in minutes to fetch services for

Response

Returns a JSON object containing train service information processed from the Darwin API.

Last updated on

Getting Started

Contributing

Docs by ReadmeBot

interface ServiceResponse {
  trainServices?: TrainService[];
  busServices?: BusService[];
  ferryServices?: FerryService[];
  locationName?: string;
  crs?: string;
  nrccMessages?: NRCCMessage[];
}

import GetNextTrainsAtStationStaff from '@api/GetNextTrainsAtStationStaff';

const staffServices = await GetNextTrainsAtStationStaff('VIC', 10);
console.log(staffServices.trainServices[0].cancelReason);

Name	Type	Required	Description
`rawServices`	RawServiceData[]	Yes	Raw service data from Darwin API
`serviceType`	string	Yes	Type of service to process

Name	Type	Required	Description
`crs`	string	Yes	Station CRS code
`numRows`	number	Yes	Number of services to fetch
`options.timeOffset`	number	No	Time offset in minutes
`options.timeWindow`	number	No	Time window in minutes
`options.staffMode`	boolean	No	Whether to use staff API endpoint

import GenerateUrl from '@api/GenerateUrl';

const url = GenerateUrl('MAN', 20, { 
  timeOffset: 0, 
  timeWindow: 120,
  staffMode: false 
});
// Returns: "https://huxley2-instance.com/departures/MAN/20?..."

Name	Type	Required	Description
`crs`	string	Yes	Three-letter CRS code

Name	Type	Required	Description
`word`	string	Yes	Word to determine article for

Property	Type	Description
`services`	ServiceResponse \| null	Service data or null if not loaded
`loading`	boolean	Whether data is currently being fetched
`error`	Error \| null	Error object if fetch failed

import useServiceInformation from '@hooks/useServiceInformation';

function TrainBoard({ stationCRS }) {
  const { services, loading, error } = useServiceInformation(stationCRS);
  
  if (loading) return <div>Loading...</div>;
  if (error) return <div>Error: {error.message}</div>;
  
  return (
    <div>
      {services?.trainServices?.map(train => (
        <div key={train.serviceID}>{train.destination}</div>
      ))}
    </div>
  );
}

Name	Type	Required	Description
`key`	string	Yes	localStorage key
`defaultValue`	T	Yes	Default value if no stored value exists

import useStateWithLocalStorage from '@hooks/useStateWithLocalStorage';

function Settings() {
  const [theme, setTheme] = useStateWithLocalStorage('theme', 'dark');
  
  return (
    <select value={theme} onChange={e => setTheme(e.target.value)}>
      <option value="dark">Dark</option>
      <option value="light">Light</option>
    </select>
  );
}

Name	Type	Required	Description
`callback`	Function	Yes	Function to execute
`delay`	number \| null	Yes	Interval in milliseconds (null to pause)

import useInterval from '@hooks/useInterval';

function Clock() {
  const [time, setTime] = useState(new Date());
  
  useInterval(() => {
    setTime(new Date());
  }, 1000);
  
  return <div>{time.toLocaleTimeString()}</div>;
}

Name	Type	Required	Description
`callback`	Function	Yes	Function to execute
`delay`	number \| null	Yes	Delay in milliseconds (null to cancel)

import useTimeout from '@hooks/useTimeout';

function DelayedMessage() {
  const [show, setShow] = useState(false);
  
  useTimeout(() => {
    setShow(true);
  }, 3000);
  
  return show ? <div>This appears after 3 seconds</div> : null;
}

API Reference

API Reference

National Rail API Integration

GET `/api/getServices`

On this page

API Reference

API Reference

National Rail API Integration

GET `/api/getServices`

On this page

Core API Functions

`GetNextTrainsAtStation`

`GetNextTrainsAtStationStaff`

`ProcessServices`

`GenerateUrl`

Utility Functions

`crsToStationName`

`getAAnSimple`

React Hooks

`useServiceInformation`

`useStateWithLocalStorage`

`useInterval`

`useTimeout`

Reference Data

Cancellation Codes

Lateness Codes

TIPLOC to Station Mapping

Configuration

Config.js