Difference between revisions of "Network Rail API Platform"

From Open Rail Data Wiki
Jump to navigation Jump to search
(Add NR API platform page)
 
(Correspondence with Network Rail reveals that new registrations for this API are currently suspended; edit access to past tense, add link to page on PDfeeds reference data, remove optimism about future additions)
Line 1: Line 1:
Through an API platform hosted by Network Rail, various programmatic interfaces to systems and data are available for consumption. At the time of writing, there is just one API, but this will be expanded in future:
+
Through an API platform hosted by Network Rail, various programmatic interfaces to systems and data are available for consumption. There is currently (June, 2023) only one API, and new registrations are suspended.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 10: Line 10:
 
| [[BPLAN_Geography|BPLAN Geography File]]
 
| [[BPLAN_Geography|BPLAN Geography File]]
 
|}
 
|}
 +
 +
== Suspension of registration ==
 +
Network Rail have suspended new registrations, directing data users to access BPLAN via the method described in [[Reference Data]] instead.
  
 
== Requesting access ==
 
== Requesting access ==
  
To request access, email opendata@networkrail.co.uk.  If granted access, you will be given a client ID and client secret.  These should be passed in the HTTP message header in the fields 'client_id' and 'client_secret'.
+
To request access, users would have emailed opendata@networkrail.co.uk.  If granted access, they were given a client ID and client secret.  These were passed in the HTTP message header in the fields 'client_id' and 'client_secret'.

Revision as of 09:49, 13 June 2023

Through an API platform hosted by Network Rail, various programmatic interfaces to systems and data are available for consumption. There is currently (June, 2023) only one API, and new registrations are suspended.

API Endpoint Usage
BPLAN (Reference Data) API https://data.networkrail.co.uk/api/pifgeography/v1/train/referenceDataFile BPLAN Geography File

Suspension of registration

Network Rail have suspended new registrations, directing data users to access BPLAN via the method described in Reference Data instead.

Requesting access

To request access, users would have emailed opendata@networkrail.co.uk. If granted access, they were given a client ID and client secret. These were passed in the HTTP message header in the fields 'client_id' and 'client_secret'.