https://wiki.openraildata.com//index.php?title=Special:NewPages&feed=atom&hideredirs=1&limit=50&offset=&namespace=0&username=&tagfilter=&size-mode=max&size=0Open Rail Data Wiki - New pages [en-gb]2024-03-29T09:58:26ZFrom Open Rail Data WikiMediaWiki 1.33.1https://wiki.openraildata.com//index.php?title=Rail_Data_Marketplace/FeedsRail Data Marketplace/Feeds2024-02-12T13:50:56Z<p>EvelynSnow: LDB</p>
<hr />
<div>This article is a list of feeds available on the [[Rail Data Marketplace]], with paid, non-open, and manual-approval entries filtered.<br />
<br />
See [[Rail Data Marketplace#Feeds]] for more explanation on the caveats in this list, particularly around "File Source" type feeds (which cannot be easily used in software), KB, LDB(SV)WS, and DTD fares/timetable/routeing information.<br />
<br />
== Feeds ==<br />
<br />
{| class="wikitable"<br />
|-<br />
! Feed name !! Publisher !! Type !! Licence !! Remarks<br />
|-<br />
|[https://raildata.org.uk/dashboard/dataProduct/P-a284788f-8f9f-4c34-bdfb-2cfaf935fb01/overview Safety data for GB mainline railway] || Rail Safety and Standards Board || File Source || OGL3 || XLSX format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-3fade1ab-0a85-4ac6-bc51-17c770350af3/overview Historic delay attribution data] || Network Rail || File Source || OGL3 || <br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-ffaa34ab-1ae7-4cc5-904b-9246bc20d651/overview Network Rail Event Planning Lookahead Calendar] || Network Rail || File Source || OGL3 || XLSX format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-c1b1cbbc-9fc5-425e-a0c9-9aa6cb5c619f/overview Origin and destination matrix (ODM) 2018-19] || Office of Rail and Road || File Source || OGL3 || CSV format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-ea6deaac-fae4-4708-8307-36ad13732a7b/overview Origin and destination matrix (ODM) 2019-20] || Office of Rail and Road || File Source || OGL3 || CSV format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-ba359b71-58c9-4f42-8c9d-e02e8e3a4330/overview Origin and destination matrix (ODM) 2020-21] || Office of Rail and Road || File Source || OGL3 || CSV format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-288cb0a6-c1de-47c0-b582-c3beb288eab9/overview Cross Country Trains Fleet accessibility matrix] || XC TRAINS LIMITED || File Source || Open || XLSX format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-cf16832d-d971-46e7-8883-4fca2101d3fa/overview Knowledgebase Incidents data] || Rail Delivery Group || API || Open || [[KnowledgeBase]] is also available through the [[National Rail Data Portal|NRDP]]. Note that the STOMP/OpenWire real-time incidents feed is not available through the RDM.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-7a5989cb-4600-4727-9ab0-baa7e483a0f2/overview Knowledgebase National Service Indicator data] || Rail Delivery Group || API || Open || [[KnowledgeBase]] is also available through the [[National Rail Data Portal|NRDP]].<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-49f7a182-c71b-45a2-b0f0-3b52c9a2968c/overview Knowledgebase TOC data] || Rail Delivery Group || API || Open || [[KnowledgeBase]] is also available through the [[National Rail Data Portal|NRDP]].<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-ce8d83cd-4950-4c3f-ae66-1701bcee7489/overview GTR Station Accessible Features] || Govia Thameslink Railway || File Source || Open || CSV format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-88ffe920-471c-4fd9-8e0d-95d5b9b7a257/overview Knowledgebase Stations data feed] || Rail Delivery Group || API || Open || [[KnowledgeBase]] is also available through the [[National Rail Data Portal|NRDP]].<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-a947deaa-06a5-4d11-afc3-86989588fcbe/overview GTR Fleet Accessibility Data] || Govia Thameslink Railway || File Source || Open || XLSX format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-fa48dff6-2b2f-438f-b66c-5ff56610d5a5/overview SWR Fleet Accessibility] || South Western Railway || File Source || Open || XLSX format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-65705362-62d0-473d-9309-314b5e41af9a/overview GWR Fleet Accessibility Data] || Great Western Railway || File Source || Open || XLSX format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-ef4faf3c-1a9e-4d83-9522-4adc86a3c708/overview TransPennine Express Accessibility Facilities] || TransPennine Express || File Source || Open || XLSX format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-ac3ac5e5-0e8f-45cc-8d52-20e317d2d6d4/overview Class 345 FLU Load Weight Measurements] || MTR Elizabeth line || File Source || OGL3 || CSV format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-740c734a-4bc4-48d2-b433-2668b7aa911c/overview Knowledgebase Incidents data feed] || Rail Delivery Group || API || Open || [[KnowledgeBase]] is also available through the [[National Rail Data Portal|NRDP]]. Note that the STOMP/OpenWire real-time incidents feed is not available through the RDM.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-54bd59fb-1d0d-4182-bd7a-f01e16c13c88/overview Knowledgebase National Service Indicator data feed] || Rail Delivery Group || API || Open || [[KnowledgeBase]] is also available through the [[National Rail Data Portal|NRDP]].<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-58c29697-5496-41e8-8582-030d69e9acc2/overview Knowledgebase Promotions data feed] || Rail Delivery Group || API || Open || [[KnowledgeBase]] is also available through the [[National Rail Data Portal|NRDP]].<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-2d177d2e-dcb8-43dc-ac4d-3a967dd35c5e/overview Knowledgebase Ticket Restrictions data feed] || Rail Delivery Group || API || Open || [[KnowledgeBase]] is also available through the [[National Rail Data Portal|NRDP]].<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-c1b1805f-b57e-416b-a6b6-72572444426d/overview Southeastern Train Accessibility Information] || Southeastern || File Source || Open || XLSX/CSV format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-404bcfb5-d31e-401a-977b-82378121413c/overview Northern Trains Accessibility Data] || Northern || File Source || OGL3 || XLSX format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-57eca15a-44c0-4fbf-aab8-d6728ace7421/overview Chiltern Railways Fleet accessibility schema] || Chiltern Railways Co Limited || File Source || Open || XLSX format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-51e17973-7327-4735-a7ca-d2a484a56065/overview Knowledgebase Ticket Types data feed] || Rail Delivery Group || API || Open || [[KnowledgeBase]] is also available through the [[National Rail Data Portal|NRDP]].<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-cfd03cae-7973-4288-a64a-5aab2624ea9f/overview Knowledgebase TOC data feed] || Rail Delivery Group || API || Open || [[KnowledgeBase]] is also available through the [[National Rail Data Portal|NRDP]].<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-9b8c568a-4933-49ee-b565-b115d7fa5c5c/overview Safety Risk Model version 9.00.01] || Rail Safety and Standards Board || File Source || OGL3 || XLSX format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-ba403ccb-1d64-40a7-8a53-23e8d05e6026/overview Daily Concourse Footfall] || Network Rail || File Source || OGL3 || CSV format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-03715cb3-22f2-48b6-94f6-bd88da9335f3/overview BPLAN Geography Data] || Network Rail || File Source || OGL3 || [[BPLAN_data_structure|BPLAN]] format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-088445e0-294a-44c9-aaf6-1223abedfd00/overview AWC Fleet Accessibility Data] || Avanti West Coast || File Source || Open || XLSX format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-a9faf6fd-b31f-491c-935a-f4ab3ffa5890/overview Origin and destination matrix (ODM) 2021-22] || Office of Rail and Road || File Source || OGL3 || CSV format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-292cd016-6b1c-4b0d-9306-e5a27559c956/overview Northern Trains Stations Data] || Northern || File Source || Open || CSV format. Consider using [[KnowledgeBase]] instead.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-f9c7e715-1367-47b0-aee3-38d73d2ebe04/overview Station attributes for all mainline stations in GB] || Office of Rail and Road || File Source || OGL3 || XLSX format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-83731f3a-2af8-495b-abab-1c753360ca35/overview Fare Group Permitted Stations Reference Data] || Rail Delivery Group || File Source || Open || XML format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-36f94f7e-4a1c-4bb9-b44e-b70758c525e1/overview Fare Group Location Associations Reference Data] || Rail Delivery Group || File Source || Open || XML format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-a88ded85-8ec1-4589-8348-35983d5d3aa9/overview Rail Rovers Reference Data] || Rail Delivery Group || File Source || Open || XML format. Consider using [[Fares Data]] (TRR) via [[National Rail Data Portal|NRDP]] instead.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-da240b95-9010-497c-8129-57ff88695d0a/overview Fare Group Members Reference Data] || Rail Delivery Group || File Source || Open || XML format. Consider using [[Fares Data]] (LOC) via [[National Rail Data Portal|NRDP]] instead.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-a96d28cb-35d4-4937-b6fb-365d01daa23b/overview Service Providers Reference Data v1.1] || Rail Delivery Group || File Source || Open || XML format. Only useful in conjunction with OJP, doesn't contain ATOC operator codes.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-f69df431-88db-4d74-9948-4a2ee9953ac6/overview Service Providers Reference Data] || Rail Delivery Group || File Source || Open || XML format. Only useful in conjunction with OJP, doesn't contain ATOC operator codes.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-daabf098-f286-4221-82e2-ec2e715fd95a/overview Railcards Reference Data v1.2] || Rail Delivery Group || File Source || Open || XML format. Consider using [[Fares Data]] (RLC) via [[National Rail Data Portal|NRDP]] instead.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-a3af2756-e4a0-4679-9f85-9a0f3067f382/overview Railcards Reference Data] || Rail Delivery Group || File Source || Open || XML format. Consider using [[Fares Data]] (RLC) via [[National Rail Data Portal|NRDP]] instead.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-eb7378f7-ed47-4f32-b792-654ce915c620/overview Fare Route Restrictions Reference Data v1.2] || Rail Delivery Group || File Source || Open || XML format. Consider using [[Fares Data]] (RTE) via [[National Rail Data Portal|NRDP]] instead.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-7a5dd727-9224-43ae-946c-8c0945786073/overview Fare Route Restrictions Reference Data] || Rail Delivery Group || File Source || Open || XML format. Consider using [[Fares Data]] (RTE) via [[National Rail Data Portal|NRDP]] instead.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-4f4a90ff-d4e2-442e-93b3-07121430f303/overview Fare Locations Reference Data v1.3] || Rail Delivery Group || File Source || Open || XML format. Consider using [[Fares Data]] (LOC) via [[National Rail Data Portal|NRDP]] instead.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-c10030ae-c22e-45c0-92f9-84aea5effc06/overview Fare Locations Reference Data] || Rail Delivery Group || File Source || Open || XML format. Consider using [[Fares Data]] (LOC) via [[National Rail Data Portal|NRDP]] instead.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-7533ba56-52bd-4d86-96ba-fd2e95fcbede/overview Ticket Types Reference Data v1.2] || Rail Delivery Group || File Source || Open || XML format. Consider using [[Fares Data]] (TTY) via [[National Rail Data Portal|NRDP]] instead.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-cbce6c40-84ed-48ea-bc38-8b2f859dbbe3/overview Ticket Types Reference Data] || Rail Delivery Group || File Source || Open || XML format. Consider using [[Fares Data]] (TTY) via [[National Rail Data Portal|NRDP]] instead.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-bc13af96-8ca5-484a-be47-2ee0a3251b01/overview Stations Reference Data v1.2] || Rail Delivery Group || File Source || Open || XML format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-027a0f6c-b6dc-46eb-b743-5c6e73137aaf/overview Stations Reference Data] || Rail Delivery Group || File Source || Open || XML format<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-9568f5b6-598e-48c6-8754-cd8c3a552d1c/overview Fixed Links] || Rail Delivery Group || File Source || Open || XML format. Consider using [[DTD:Timetable]] (ALF) via [[National Rail Data Portal|NRDP]] instead.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-54966b86-7f3a-4e43-8c78-b1e400927f2a/overview London Terminals Feed Data v1.4] || Rail Delivery Group || File Source || Open || XML format. Consider using the Routeing Guide (RGC) via [[National Rail Data Portal|NRDP]] instead.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-b3102979-7517-49a6-976a-00e14bc00593/overview London Terminals Feed Data] || Rail Delivery Group || File Source || Open || XML format. Consider using the Routeing Guide (RGC) via [[National Rail Data Portal|NRDP]] instead.<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-ed23401e-d776-496b-9bda-bc40c9543b86/overview Disruptions API - Station Alerts] || Rail Delivery Group || API || || <br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-2a25fc6d-4c6e-43f2-b054-6fe45bf25645/overview Disruptions API - Consolidated Information] || Rail Delivery Group || API || || <br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-914a57c8-d010-48ef-bd9e-4a94fd0dddc5/overview NaPTAN & NPTG] || Department for Transport || API || OGL3 || <br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-5b5519bb-be56-493a-97ce-d723db3d93e0/overview Rail Date API] || OpenTrainTimes Ltd. || API || Open || <br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-0a6089d3-069c-4949-85ca-e7fdd62a7a20/overview Live Next Departures Board - Staff Version] || Rail Delivery Group || API || Open || Broken, see [[About the National Rail Feeds#Registering_for_OpenLDBSV.2FDarwin_Staff_Webservice|here]] for LDBSVWS registration<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-75b78055-54f2-4865-b775-e1ac717a8016/overview Live Fastest Departures Board - Staff Version] || Rail Delivery Group || API || Open || Broken, see [[About the National Rail Feeds#Registering_for_OpenLDBSV.2FDarwin_Staff_Webservice|here]] for LDBSVWS registration<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-a9e90d13-3a13-4eda-b34b-5afeeffc3fec/overview Service Details] || Rail Delivery Group || API || Open || This information is also available through the [[NRE_Darwin_Web_Service_(Public)|LDB SOAP service]].<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-6226bbd0-5ca7-4d94-ba28-1504c30dc068/overview Live Next Departures Board] || Rail Delivery Group || API || Open || This information is also available through the [[NRE_Darwin_Web_Service_(Public)|LDB SOAP service]].<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-4600b51c-29c6-4cab-b5b0-333c32cf5d3c/overview Live Fastest Departures Board] || Rail Delivery Group || API || Open || This information is also available through the [[NRE_Darwin_Web_Service_(Public)|LDB SOAP service]].<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-7c866984-8a7b-4272-a6f8-00b4aaf821fa/overview Live Arrival and Departure Boards] || Rail Delivery Group || API || Open || This information is also available through the [[NRE_Darwin_Web_Service_(Public)|LDB SOAP service]].<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-d904019d-1b74-4605-a592-9514883de16f/overview Live Arrival Board] || Rail Delivery Group || API || Open || This information is also available through the [[NRE_Darwin_Web_Service_(Public)|LDB SOAP service]].<br />
|-<br />
| [https://raildata.org.uk/dataProduct/P-9a01dd96-7211-4912-bcbb-c1b5d2e35609/overview Live Departure Board] || Rail Delivery Group || API || Open || This information is also available through the [[NRE_Darwin_Web_Service_(Public)|LDB SOAP service]].<br />
|}</div>EvelynSnowhttps://wiki.openraildata.com//index.php?title=Rail_Data_MarketplaceRail Data Marketplace2024-02-12T13:45:36Z<p>EvelynSnow: Substitutions section in more detail</p>
<hr />
<div>The '''Rail Data Marketplace''' is a rail data platform operated by the Rail Delivery Group. Some existing open feeds are also offered through the marketplace, some new feeds are only offered through the marketplace.<br />
<br />
= Background =<br />
The RDG states that the Rail Data Marketplace originates in the Joint Rail Data Action Plan, and Williams-Shapps Plan for Rail.<ref>https://raildata.org.uk/dashboard/helpAndInformation/aboutRDM</ref><br />
<br />
The Joint Rail Data Action Plan is a policy paper published in 2018, which sought to increase rail data sharing across the industry, and which criticised the "perceived closed nature of the railway industry";<ref>https://www.gov.uk/government/publications/joint-rail-data-action-plan/joint-rail-data-action-plan-addressing-barriers-to-make-better-use-of-rail-data</ref> The Rail Delivery Group committed in the joint action plan to publishing the CTI and CIGP feeds through the [[National Rail Data Portal|NRDP]], but failed to do so. The Williams-Shapps Plan for Rail outlined the strategy and objectives of an "open by default" Rail Data Service under the proposed Great British Railways.<ref>https://assets.publishing.service.gov.uk/media/60cb29dde90e0743ae8c29c1/gbr-williams-shapps-plan-for-rail.pdf (56)</ref><br />
<br />
In 2021, the Department for Transport announced £5 million in government funding for a new Rail Data Marketplace,<ref>https://www.gov.uk/government/news/data-revolution-set-to-improve-rail-travel-for-passengers</ref> with the Rail Delivery Group selecting Tata Consultancy Services to develop the platform.<ref>https://www.tcs.com/who-we-are/newsroom/press-release/rail-delivery-group-selects-tcs-to-help-create-uk-government-rail-data-marketplace</ref><br />
<br />
= Feeds =<br />
A summary of some feeds is available [[Rail Data Marketplace/Feeds|here]]. Every feed requires a separate subscription, and agreement by the user to a separate licence agreement. There are two types of feed - files, and APIs. There's no officially documented or supported mechanism for retrieving files from the Rail Data Marketplace in software.<br />
<br />
== Substitutions ==<br />
* Some fares, timetable, and routeing file feeds can be replaced with [[DTD]] files, which can be retrieved automatically from the [[National Rail Data Portal|NRDP]].<br />
* [[KnowledgeBase|KB]] feeds are APIs – not files – on the RDM, but it may still be more convenient to access these through the NRDP instead of the RDM, as you'll only need to enable one subscription, with one set of secrets.<br />
* Similarly, it may be more convenient to use the LDB [[NRE_Darwin_Web_Service_(Public)|SOAP service]] instead of the RDM offering, which is split across multiple endpoints, with separate secrets.<br />
* The "Staff Version" web service on the RDM doesn't currently work, the LDBSVWS [[NRE_Darwin_Web_Service_(Staff)|SOAP service]] is the only alternative (see [[About_the_National_Rail_Feeds#Registering_for_OpenLDBSV.2FDarwin_Staff_Webservice|here]] for special registration information about LDBSVWS).<br />
<br />
= Criticism =<br />
The Rail Data Marketplace is controversial among feeds users.<ref>https://groups.google.com/g/openraildata-talk/c/T1ejY551ZUw/m/Hjpd4YdFBgAJ</ref><ref>https://groups.google.com/g/openraildata-talk/c/xbqi6dOP4XU/m/Tcw3M_PTBAAJ</ref><ref>https://groups.google.com/g/openraildata-talk/c/qAErlL2oRxc/m/TgiMq9QaAwAJ</ref> <br />
<br />
= References =<br />
<references /></div>EvelynSnowhttps://wiki.openraildata.com//index.php?title=Train_Call_WindowTrain Call Window2024-02-07T13:52:15Z<p>PeterHicks: Fix table formatting</p>
<hr />
<div>Trains known to TRUST are assigned a 10-character TRUST train identity during a process known as train call. Once a train has a TRUST train identity, it can be cancelled, altered or reported against.<br />
<br />
Train call can take place manually up to about 9 hours prior to the train's booked departure (such as if it is being cancelled early in the day, or if it is not an auto-called train), or it can happen automatically via a scheduled process.<br />
<br />
The auto train call windows, in hours, are as follows:<br />
<br />
{|class="wikitable"<br />
!Class<br />
!Until 2024-02-16 1800<br />
!From 2024-02-16 1800<br />
|-<br />
|0<br />
|1<br />
|3<br />
|-<br />
|1<br />
|1<br />
|1<br />
|-<br />
|2<br />
|2<br />
|1<br />
|-<br />
|3<br />
|1<br />
|1<br />
|-<br />
|4<br />
|2<br />
|3<br />
|-<br />
|5<br />
|2<br />
|1<br />
|-<br />
|6<br />
|2<br />
|3<br />
|-<br />
|7<br />
|2<br />
|3<br />
|-<br />
|8<br />
|2<br />
|3<br />
|-<br />
|9<br />
|1<br />
|1<br />
|-<br />
|}</div>PeterHickshttps://wiki.openraildata.com//index.php?title=Stations_Experience_API/Figure_1_StationsStations Experience API/Figure 1 Stations2024-02-05T16:37:01Z<p>EvelynSnow: Revise stations list in accordance with unannounced changes</p>
<hr />
<div>This is an annotated list of stations in Figure 1 in the [[:File:Final_Lifts_and_Escalators_API_protocol_for_displaying_API_info_v1.1.docx|mandatory protocol]], which can also be seen online on the [https://anypoint.mulesoft.com/exchange/portals/network-rail-0/4ab2552f-66c9-424e-bd5b-43e12c248732/e-nr-stations/minor/1.0/pages/4qa-c6x/Data%20Publishing%20Guidelines/ official API documentation].<br />
<br />
The list supposedly reflects stations where the lifts are operated by TfL and live information isn't available through the API, but includes a number of DLR/tube stations without any corresponding national rail station, and stations outside of London not owned or managed by TfL. Some entries in the list nevertheless have lift status coverage through the API.<br />
<br />
= The mandatory protocol =<br />
<blockquote><br />
Note: some stations with lifts are not owned by Network Rail and therefore may not have live reporting of lifts. These include the following Transport for London stations where you can direct users to Transport for London for information on live availability rather than displaying this API information if no live data is available.<br />
<br />
Example:<br />
<br />
“There are TfL operated lifts at this station, but currently, no live data is available.<br />
<br />
Please check TfL webpages for lift status.”<br />
</blockquote><br />
<br />
= The list =<br />
The list has been revised once, between 2024-02-05 and 2024-02-07, station names in bold were changed, struck station names were removed.<br />
<br />
{| class="wikitable"<br />
|-<br />
! Station name !! CRS !! Matched using !! Remarks<br />
|-<br />
| '''Kings Cross St Pancras''' || KGX, STP || Manual || ''7 assets in API''<br />
|-<br />
| '''Denmark Hill''' || DMK || Manual || ''3 assets in API''<br />
|-<br />
| <del>'''Warwick Parkway'''</del> || WRP || Darwin (exact match) || Station is in Warwick, closer to Birmingham than London<br />
|-<br />
| <del>'''Princes Risborough PRR'''</del> || PRR || Manual substitution || Station is some distance outside London, and managed by Chiltern<br />
|-<br />
| Acton Main Line || AML || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Brockley || BCY || Darwin (exact match) || ''1 asset in API''<br />
|-<br />
| Bromley South || BMS || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Brentwood || BRE || Darwin (exact match) || <br />
|-<br />
| Burnham || BNM || Darwin (exact match) || ''1 asset in API''<br />
|-<br />
| Chadwell Heath || CTH || Darwin (exact match) || <br />
|-<br />
| Caledonian Road & Barnsbury || CIR || Manual substitution || ''2 assets in API''<br />
|-<br />
| Camden Road || CMD || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Canonbury || CNN || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| Coulsdon South || CDS || Darwin (exact match) || <br />
|-<br />
| Charlton || CTN || Darwin (exact match) || ''1 asset in API''<br />
|-<br />
| Carshalton || CSH || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| City Thameslink || CTK || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Dalston Junction || DLJ || Darwin (exact match) || <br />
|-<br />
| Dartford || DFD || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| Deptford || DEP || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Edmonton Green || EDR || Darwin (exact match) || <br />
|-<br />
| Elstree & Borehamwood || ELS || Darwin (exact match) || <br />
|-<br />
| Mitcham Eastfields || MTC || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Forest Hill || FOH || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Forest Gate || FOG || Darwin (exact match) || <br />
|-<br />
| Gidea Park || GDP || Darwin (exact match) || <br />
|-<br />
| Goodmayes || GMY || Darwin (exact match) || <br />
|-<br />
| Gospel Oak || GPO || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Hackney Central || HKC || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| Hackney Wick || HKW || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Haggerston || HGG || Darwin (exact match) || <br />
|-<br />
| Hanwell || HAN || Darwin (exact match) || <br />
|-<br />
| Hayes & Harlington || HAY || Darwin (exact match) || ''4 assets in API''<br />
|-<br />
| Herne Hill || HNH || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Hampstead Heath || HDH || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Honor Oak Park || HPA || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Hoxton || HOX || Darwin (exact match) || <br />
|-<br />
| Harold Wood || HRO || Darwin (exact match) || <br />
|-<br />
| Iver || IVR || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| Kensal Rise || KNR || Darwin (exact match) || <br />
|-<br />
| Ilford || IFD || Darwin (exact match) || <br />
|-<br />
| Langley || LNY || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| Manor Park || MNP || Darwin (exact match) || <br />
|-<br />
| Maidenhead || MAI || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Maryland || MYL || Darwin (exact match) || <br />
|-<br />
| Orpington || ORP || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| Queens Road Peckham || QRP || Darwin (exact match) || ''1 asset in API''<br />
|-<br />
| Purley || PUR || Darwin (exact match) || ''4 assets in API''<br />
|-<br />
| Reading || RDG || Darwin (exact match) || ''18 assets in API''. Station is outside London, and owned and managed by Network Rail.<br />
|-<br />
| Shenfield || SNF || Darwin (exact match) || <br />
|-<br />
| Shoreditch High Street || SDC || Darwin (exact match) || <br />
|-<br />
| Slough || SLO || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| Southall || STL || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| St Mary Cray || SMY || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| South Tottenham || STO || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Seven Kings || SVK || Darwin (exact match) || <br />
|-<br />
| Swanley || SAY || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Taplow || TAP || Darwin (exact match) || ''1 asset in API''<br />
|-<br />
| Twyford || TWY || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| West Drayton || WDT || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| West Ealing || WEA || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| White Hart Lane || WHL || Darwin (exact match) || <br />
|-<br />
| West Hampstead || WHD || Darwin (exact match) || <br />
|-<br />
| West Hampstead Thameslink || WHP || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| Abbey Road || || ''DLR'' || <br />
|-<br />
| All Saints || || ''DLR'' || <br />
|-<br />
| Blackwall || || ''DLR'' || <br />
|-<br />
| Bow Church || || ''DLR'' || <br />
|-<br />
| Crossharbour || || ''DLR'' || <br />
|-<br />
| Custom House for ExCel || CUS || Manual substitution || <br />
|-<br />
| Deptford Bridge || || ''DLR'' || <br />
|-<br />
| Devons Road || || ''DLR'' || <br />
|-<br />
| East India || || ''DLR'' || <br />
|-<br />
| Gallions Reach || || ''DLR'' || <br />
|-<br />
| Heron Quays || || ''DLR'' || <br />
|-<br />
| Island Gardens || || ''DLR'' || <br />
|-<br />
| King George V || || ''DLR'' || <br />
|-<br />
| Langdon Park || || ''DLR'' || <br />
|-<br />
| Pontoon Dock || || ''DLR'' || <br />
|-<br />
| Poplar || || ''DLR'' || <br />
|-<br />
| Prince Regent || || ''DLR'' || <br />
|-<br />
| Pudding Mill Lane || || ''DLR'' || <br />
|-<br />
| Royal Albert || || ''DLR'' || <br />
|-<br />
| Royal Victoria || || ''DLR'' || <br />
|-<br />
| Stratford High Street || || ''DLR'' || <br />
|-<br />
| Stratford International || SFA || Darwin (exact match) || <br />
|-<br />
| South Quay || || ''DLR'' || <br />
|-<br />
| Star Lane || || ''DLR'' || <br />
|-<br />
| Westferry || || ''DLR'' || <br />
|-<br />
| West India Quay || || ''DLR'' || <br />
|-<br />
| West Silvertown || || ''DLR'' || <br />
|-<br />
| Acton Town || || ''London Underground'' || <br />
|-<br />
| Bromley-by-Bow || || ''London Underground'' || <br />
|-<br />
| Bermondsey || || ''London Underground'' || <br />
|-<br />
| Bond Street || BDS || Darwin (exact match) || <br />
|-<br />
| Borough || || ''London Underground'' || <br />
|-<br />
| Caledonian Road || || ''London Underground'' || <br />
|-<br />
| Cockfosters || || ''London Underground'' || <br />
|-<br />
| Debden || || ''London Underground'' || <br />
|-<br />
| Earl's Court || || ''London Underground'' || <br />
|-<br />
| Edgware || || ''London Underground'' || <br />
|-<br />
| East Ham || || ''London Underground'' || <br />
|-<br />
| Euston Square || || ''London Underground'' || <br />
|-<br />
| Fulham Broadway || || ''London Underground'' || <br />
|-<br />
| Finchley Central || || ''London Underground'' || <br />
|-<br />
| Golders Green || || ''London Underground'' || <br />
|-<br />
| Green Park || || ''London Underground'' || <br />
|-<br />
| Hendon Central || || ''London Underground'' || <br />
|-<br />
| Hillingdon || || ''London Underground'' || <br />
|-<br />
| Hainault || || ''London Underground'' || <br />
|-<br />
| Hounslow East || || ''London Underground'' || <br />
|-<br />
| Hounslow West || || ''London Underground'' || <br />
|-<br />
| Ickenham || || ''London Underground'' || <br />
|-<br />
| Kilburn || || ''London Underground'' || <br />
|-<br />
| Kingsbury || || ''London Underground'' || <br />
|-<br />
| Morden || || ''London Underground'' || <br />
|-<br />
| Mill Hill East || || ''London Underground'' || <br />
|-<br />
| Newbury Park || || ''London Underground'' || <br />
|-<br />
| North Greenwich || || ''London Underground'' || <br />
|-<br />
| Oakwood || || ''London Underground'' || <br />
|-<br />
| Osterley || || ''London Underground'' || <br />
|-<br />
| Pinner || || ''London Underground'' || <br />
|-<br />
| Southfields || || ''London Underground'' || <br />
|-<br />
| Sudbury Hill || || ''London Underground'' || <br />
|-<br />
| Southwark || || ''London Underground'' || <br />
|-<br />
| Tottenham Court Road || TCR || Darwin (exact match) || <br />
|-<br />
| Tower Hill || ZTH || Manual substitution || <br />
|-<br />
| Wood Lane || || ''London Underground'' || <br />
|-<br />
| Wimbledon Park || WPK || Manual substitution || <br />
|-<br />
| Wembley Park || || ''London Underground'' || <br />
|-<br />
| Bank || || ''London Underground'' || <br />
|-<br />
| Blackfriars || BFR || Manual substitution || ''7 assets in API''<br />
|-<br />
| Blackhorse Road || BHO || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Barking || BKG || Darwin (exact match) || <br />
|-<br />
| Brixton || BRX || Darwin (exact match) || <br />
|-<br />
| Canning Town || || ''London Underground'' || <br />
|-<br />
| Canary Wharf || CWX || Manual substitution || <br />
|-<br />
| Clapham Junction || CLJ || Darwin (exact match) || ''10 assets in API''. Clapham Junction has no underground station.<br />
|-<br />
| Cannon Street || CST || Manual substitution || ''2 assets in API''<br />
|-<br />
| Cutty Sark for Maritime Greenwich || || ''DLR'' || <br />
|-<br />
| Crystal Palace || CYP || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| East Croydon || ECR || Darwin (exact match) || ''4 assets in API''<br />
|-<br />
| Elephant & Castle || EPH || Darwin (exact match) || <br />
|-<br />
| Finsbury Park || FPK || Darwin (exact match) || ''1 asset in API''<br />
|-<br />
| Greenford || GFD || Darwin (exact match) || <br />
|-<br />
| Greenwich || GNW || Darwin (exact match) || <br />
|-<br />
| Harrow-on-the-Hill || HOH || Darwin (exact match) || <br />
|-<br />
| Heathrow Terminals 2 & 3 || HXX || Manual substitution || <br />
|-<br />
| Highbury & Islington || HHY || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| Hammersmith || ZHA || Manual substitution || <br />
|-<br />
| Harrow & Wealdstone || HRW || Darwin (exact match) || ''4 assets in API''<br />
|-<br />
| Heathrow Terminal 4 || HAF || Manual substitution || <br />
|-<br />
| Heathrow Terminal 5 || HWV || Manual substitution || <br />
|-<br />
| Imperial Wharf || IMW || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| London Bridge || LBG || Darwin (exact match) || ''7 assets in API''<br />
|-<br />
| London City Airport || || ''DLR'' || <br />
|-<br />
| Limehouse || LHS || Darwin (exact match) || <br />
|-<br />
| Liverpool Street || LST || Manual substitution || ''1 asset in API''<br />
|-<br />
| New Cross Gate || NXG || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| Paddington || PAD || Manual substitution || ''5 assets in API''<br />
|-<br />
| Richmond || RMD || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| Shadwell || SDE || Darwin (exact match) || <br />
|-<br />
| Shepherd's Bush || SPB || Manual substitution || ''2 assets in API''<br />
|-<br />
| Stratford || SRA || Manual substitution || ''10 assets in API''<br />
|-<br />
| Tower Gateway || ZTG || Manual substitution || <br />
|-<br />
| Tottenham Hale || TOM || Darwin (exact match) || <br />
|-<br />
| Upminster || UPM || Darwin (exact match) || <br />
|-<br />
| Victoria || VIC || Manual substitution || ''3 assets in API''<br />
|-<br />
| Vauxhall || VXH || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| Waterloo || WAT || Manual substitution || ''2 assets in API''<br />
|-<br />
| West Brompton || WBP || Darwin (exact match) || ''2 assets in API''<br />
|-<br />
| West Ham || WEH || Darwin (exact match) || <br />
|-<br />
| Watford Junction || WFJ || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| Willesden Junctions || WIJ || Manual substitution || ''2 assets in API''<br />
|-<br />
| Wimbledon || WIM || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| Wembley Central || WMB || Darwin (exact match) || ''3 assets in API''<br />
|-<br />
| Westminster || || ''London Underground'' || <br />
|-<br />
| Woolwich Arsenal || WWA || Darwin (exact match) || <br />
|-<br />
| Canada Water || ZCW || Darwin (exact match) || <br />
|-<br />
| Farringdon || ZFD || Darwin (exact match) || <br />
|-<br />
| Ealing Broadway || EAL || Darwin (exact match) || <br />
|-<br />
| Amersham || AMR || Darwin (exact match) || <br />
|-<br />
| Moorgate || MOG || Darwin (exact match) || <br />
|-<br />
| Whitechapel || ZLW || Darwin (exact match) || <br />
|-<br />
| Nine Elms || || ''London Underground'' || <br />
|-<br />
| Battersea Power Station || || ''London Underground'' || <br />
|-<br />
| Woolwich || WWC || Manual substitution || <br />
|-<br />
| Abbey Wood || ABW || Darwin (exact match) || <br />
|-<br />
| Barbican || ZBB || Manual substitution || <br />
|-<br />
| Romford || RMF || Darwin (exact match) || <br />
|-<br />
| Barking Riverside || BGV || Darwin (exact match) || <br />
|}</div>EvelynSnowhttps://wiki.openraildata.com//index.php?title=Stations_Experience_APIStations Experience API2024-01-22T20:52:24Z<p>EvelynSnow: Add note about justifying access</p>
<hr />
<div>Network Rail's Stations Experience API provides endpoints to retrieve details of lift and escalator status over an HTTP endpoint. The API is documented [https://anypoint.mulesoft.com/exchange/portals/network-rail-0/ here].<br />
<br />
= Access =<br />
<br />
To request access to the API, email [mailto:apiintegrationservicesc4e@networkrail.co.uk APIIntegrationServicesC4E@networkrail.co.uk] and request access to 's-nr-sfdc-liftsandescalator' and 'e-nr-stations'. You may be asked to justify your request for access, which will only be given if your response is satisfactory.<ref>https://groups.google.com/g/openraildata-talk/c/QpMtQjeechk/m/nE5ia9o3BAAJ</ref><br />
<br />
You will receive an email some time later containing a client ID and secret. These are effectively your user identity and password for access to the API. There is no automated mechanism for signup at the time of writing.<br />
<br />
= Restrictions =<br />
<br />
There are some restrictions placed on what can be done with the data. Specifically, the data is licensed under the [https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/ Open Government Licence v3.0], with a [https://anypoint.mulesoft.com/exchange/portals/network-rail-0/4ab2552f-66c9-424e-bd5b-43e12c248732/e-nr-stations/minor/1.0/pages/4qa-c6x%2FData%20Publishing%20Guidelines/ mandatory protocol] ([[:File:Final_Lifts_and_Escalators_API_protocol_for_displaying_API_info_v1.1.docx|initial version]]) which sets out the requirements for using this data. Note that the protocol - and its list of stations - may change without warning, and that no changelog is provided.<br />
<br />
== The mandatory protocol (summary) ==<br />
Consult the protocol (linked above) for the canonical version of the guidance. For further details, please contact Network Rail.<br />
<br />
# Use identical symbols, wording, and section structure to the [https://accessmap.nationalrail.co.uk/ National Rail access map] only<br />
# Display a mandatory disclaimer on live lift data with specific wording<br />
# Display only in-commission and public-facing lifts, don't display any escalators<br />
# Do not display fields marked in the protocol as not for public display<br />
# Display a mandatory disclaimer about no live data being available for TfL lifts for stations in Figure 1. Note that the list of stations in Figure 1 contains a number of significant errors, including stations with lifts managed by Network Rail, and stations far from London. Note that live data [https://api-portal.tfl.gov.uk/api-details#api=Disruptions-Lifts-v2&operation=get is available] for TfL lifts. An annotated version of the Figure 1 list is [[Stations_Experience_API/Figure_1_Stations|is available on this wiki]].<br />
<br />
= Base URL =<br />
<br />
All HTTP requests to this endpoint start with '''https://data.networkrail.co.uk/api/stations/v1.0/'''. Making a GET request to this URL without a valid client ID and secret will result in an HTTP 401 response with the following body:<br />
<br />
<pre><br />
{<br />
"error": "Authentication denied."<br />
}<br />
</pre><br />
<br />
= Authorization =<br />
<br />
These headers must be passed with every HTTP request:<br />
<br />
{| class="wikitable"<br />
!Header<br />
!Description<br />
!Example<br />
|-<br />
|client_id<br />
|Client ID<br />
|1a3rfe496jfkms49402srr93<br />
|-<br />
|client_secret<br />
|Client secret<br />
|7o9der492wklsmnxcvrt48f1<br />
|-<br />
|x-correlation-id<br />
|Correlation ID (any text)<br />
|1705956083<br />
|-<br />
|Accept<br />
|Standard Accept header ([https://datatracker.ietf.org/doc/html/rfc9110#name-accept RFC9110])<br />
|application/json ''or'' */*<br />
|}<br />
<br />
The correlation ID is just an identifier which is returned in the response, it doesn't need to be unique to the request. The ''Accept'' header is required, but some clients automatically set it, and the API will provide a descriptive error message if the header isn't provided.<br />
<br />
== Example (HTTP) ==<br />
<br />
<pre><br />
GET /api/stations/v1.0/stations/crs-codes/WAT/lifts-and-escalators HTTP/1.1<br />
Host: data.networkrail.co.uk<br />
Accept: */*<br />
client_id: 1a3rfe496jfkms49402srr93<br />
client_secret: 7o9der492wklsmnxcvrt48f1<br />
x-correlation-id: 1705956083<br />
</pre><br />
<br />
== Example (cURL) ==<br />
<pre><br />
curl 'https://data.networkrail.co.uk/api/stations/v1.0/stations/crs-codes/WAT/lifts-and-escalators' \<br />
-H 'client_id: 1a3rfe496jfkms49402srr93' \<br />
-H 'client_secret: 7o9der492wklsmnxcvrt48f1' \<br />
-H 'x-correlation-id: 1705956083'<br />
</pre><br />
<br />
= Responses =<br />
<br />
All responses are in JSON and have a 'header' and 'data' key.<br />
<br />
The following key/value pairs are supplied underneath the 'header' key:<br />
<br />
{| class="wikitable"<br />
!Key<br />
!Value<br />
!Description<br />
|-<br />
|apiName<br />
|e-nr-stations<br />
|Name of the responding API<br />
|-<br />
|apiVersion<br />
|v1.0<br />
|Current API version<br />
|-<br />
|correlationId<br />
|1705956083<br />
|The correlationId passed in the HTTP request<br />
|}<br />
<br />
The 'data' key contains the JSON response from the API.<br />
<br />
= Endpoint parameters =<br />
== .../lifts-and-escalators ==<br />
All endpoints ending in /lifts-and-escalators (i.e. endpoints which return multiple lifts/escalators) appear to support these get parameters, with the same behaviour. All parameters are optional.<br />
{| class="wikitable"<br />
|-<br />
! Name !! Valid values !! Remark<br />
|-<br />
| status || <code>Available</code>, <code>Not Available</code>, or <code>Not Known</code> || Note that the case must be matched. When URL-encoded, the spaces are replaced by <code>+</code> (e.g. <code>?status=Not+Available</code>)<br />
|-<br />
| customerFacingOnly || <code>true</code> or <code>false</code> || If not provided, both customer and non customer facing assets will be returned. '''if anything other than <code>true</code> - exactly as cased - is passed (including <code>false</code>), <u>only</u> non-customer-facing assets will be included.'''<br />
|-<br />
| inCommissionOnly || <code>true</code> or <code>false</code> || If <code>true</code> is passed, only in-commission assets will be returned. If anything other than <code>true</code> - exactly as cased - is passed, it'll be taken as <code>false</code> and both in-commission and non-commission assets will be returned.<br />
|-<br />
| assetType || <code>Lift</code> or <code>Escalator</code> || Returns all asset types if omitted. Note that the case must be matched, it's <code>Lift</code> not <code>lift</code><br />
|}<br />
<br />
= Endpoints =<br />
The following endpoints exist:<br />
<br />
== /ping ==<br />
This endpoint will identify whether the API is up.<br />
<br />
== /stations ==<br />
All locations, with IDs, and CRS codes. Despite the name of the endpoint, many locations are not stations, and many do not have any lifts or escalators.<br />
<br />
== /stations/all/lifts-and-escalators ==<br />
This endpoint will return details of the availability of all lifts and escalators included in the API.<br />
<br />
Note that the API gateway does not support any HTTP compression methods. As of 2024-02-05, a full response is approximately 1.5MiB, customer-facing only (<code>?customerFacingOnly=true</code>) is approximately 1.2MiB, customer-facing only with only in-commission lifts (<code>?customerFacingOnly=true&inCommissionOnly=true&assetType=Lift</code>, [https://data.networkrail.co.uk/api/stations/v1.0/stations/all/lifts-and-escalators?customerFacingOnly=true&inCommissionOnly=true&assetType=Lift full URL]) is approximately 1.1M.<br />
<br />
== /stations/crs-codes/{crs-code}/lifts-and-escalators ==<br />
This endpoint will return details of the availability of all lifts and escalators at the given station, identified by CRS code<br />
<br />
== /stations/{station-id}/lifts-and-escalators ==<br />
Availability of known lifts and escalators at the given station, identified by ID, '''not''' CRS code.<br />
<br />
== /stations/{station-id}/lifts-and-escalators/{lift-or-escalator-id} ==<br />
This endpoint will return details of a specific lift at a specific station. Note that you must use the location ID, not CRS code. The lift/escalator ID is the block ID of the lift or escalator.<br />
<br />
== /regions ==<br />
This endpoint should return the names and IDs of Network Rail's five regions.<br />
<br />
{| class="wikitable"<br />
|-<br />
! Region name !! Region ID<br />
|-<br />
| Wales & Western Region || 0Hh4K0000000XR8SAM<br />
|-<br />
| Scotland Region || 0Hh4K0000008zLDSAY<br />
|-<br />
| Eastern Region || 0Hh4K0000008zMcSAI<br />
|-<br />
| Southern Region || 0Hh4K0000008zNESAY<br />
|-<br />
| North West & Central Region || 0Hh4K0000000XQTSA2<br />
|}<br />
<br />
== /regions/{region-id}/lifts-and-escalators ==<br />
All lifts and escalators within a region<br />
<br />
== /tocs ==<br />
Names and IDs of operators<br />
<br />
== /tocs/{toc-id}/lifts-and-escalators ==<br />
All lifts and escalators assigned to a particular operator<br />
<br />
== /routes ==<br />
Routes and IDs<br />
<br />
== /routes/{route-id}/lifts-and-escalators ==<br />
All lifts and escalators assigned to a particular route<br />
<br />
= Types =<br />
Note that the official documentation doesn't describe the purpose of any fields, and implies incorrect types for a number of them.<br />
<br />
Keys in bold are those which the mandatory protocol permits you to show to passengers.<br />
<br />
== Lift/Escalator ==<br />
{| class="wikitable"<br />
|-<br />
! Key !! Null? !! Type !! Example !! Remark<br />
|-<br />
| blockId || N || String || <code>"10866"</code> || Primary key<br />
|-<br />
| blockTitle || N || String || <code>"Lancaster Stn Lift/Escalator 01"</code> || Internal-facing name for the asset<br />
|-<br />
| '''alternateName''' || Y || String || <code>"Lift, Platform 4"</code> || Short descriptive name<br />
|-<br />
| '''type''' || N || String enum: <code>"Lift"</code>, <code>"Escalator"</code> || <code>"Lift"</code> || Whether this is a lift or escalator<br />
|-<br />
| uprn || Y || String || <code>"147969000"</code> || Non-unique asset identifier?<br />
|-<br />
| '''status''' || N || String enum: <code>"Available"</code>, <code>"Not Available"</code>, <code>"Unknown"</code> || <code>"Available"</code> || Status of the asset<br />
|-<br />
| operationalStatus || N || String enum: <code>"Operational"</code>, <code>"Ownership Transferred"</code>, <code>"Demolished"</code>, <code>"Out of use"</code> || <code>"Operational"</code> || Operational status of lift. Note that the observed statuses might not reflect all possibilities.<br />
|-<br />
| updatedTime || Y || String (ISO datestamp) || <code>"2024-02-06T12:59:42.000Z"</code> || Time sensor information was last updated?<br />
|-<br />
| customerFacingFlag || N || String (boolean) || <code>"true"</code> || Whether the lift is customer-facing. '''Wrongly typed (as bool) in documentation.'''<br />
|-<br />
| inCommissionFlag || N || Boolean || <code>true</code> || Whether the lift is in commission. '''Note that this field is actually boolean, rather than true/false in a string.'''<br />
|-<br />
| '''station''' || N || ''Station'' || || Which location (not necessarily a station) this asset is in<br />
|-<br />
| region || N || ''Region'' || || Which [https://www.networkrail.co.uk/running-the-railway/our-regions/ region] this asset is in<br />
|-<br />
| route || N || ''Route'' || || Which [https://www.networkrail.co.uk/running-the-railway/our-routes/ route] this asset is in<br />
|-<br />
| toc || N || ''TOC'' || || The applicable Train Operating Company (TOC)<br />
|-<br />
| long || Y || String (float) || <code>"-2.8072"</code> || Longitude of the station/asset?<br />
|-<br />
| lat || Y || String (float) || <code>"54.0488"</code> || Latitude of the station/asset?<br />
|-<br />
| engineerOnSite || N || String (boolean) || <code>"true"</code> || Whether an engineer is on site. '''Wrongly typed (as bool) in documentation.'''<br />
|-<br />
| independent || N || String (boolean) || <code>"false"</code> || Whether the asset is in [https://en.wikipedia.org/wiki/Elevator#Independent_service independent service] mode. '''Wrongly typed (as bool) in documentation.'''<br />
|-<br />
| isolated || N || String (boolean) || <code>"false"</code> || Whether the asset is isolated? '''Wrongly typed (as bool) in documentation.'''<br />
|-<br />
| sensorId || Y || String || <code>"8759"</code> || The ID of the relevant sensor<br />
|-<br />
| timeToFix || Y || String (ISO datestamp) || <code>"2024-02-02T23:00:00.000"</code> || Date of planned fix?<br />
|-<br />
|}<br />
<br />
== Region/Route ==<br />
{| class="wikitable"<br />
|-<br />
! Key !! Null? !! Type !! Example !! Remark<br />
|-<br />
| id || N || String || <code>"0Hh4K0000000XQYSA2"</code> || Opaque ID<br />
|-<br />
| name || N || String || <code>"North West Route"</code> || Name of region or route<br />
|}<br />
<br />
== TOC ==<br />
{| class="wikitable"<br />
|-<br />
! Key !! Null? !! Type !! Example !! Remark<br />
|-<br />
| id || Y || String || <code>"0014K00000bX7FeQAK"</code> || Opaque ID<br />
|-<br />
| name || Y || String || <code>"First Great Western TOC"</code> || Name of train operating company<br />
|}<br />
<br />
== Station ==<br />
{| class="wikitable"<br />
|-<br />
! Key !! Null? !! Type !! Example !! Remark<br />
|-<br />
| id || N || String || <code>"02i4K00000FIHGkQAP"</code> || Opaque ID<br />
|-<br />
| '''crsCode''' || Y || String || <code>"HIL"</code> || CRS code of location<br />
|-<br />
| '''name''' || N || String || <code>"Hillside Stn"</code> || Location name<br />
|-<br />
| postCode || Y || String || <code>"PR8 4QR"</code> || Postcode of location (omitted in documentation)<br />
|-<br />
|}<br />
<br />
= References =<br />
<references /></div>PeterHickshttps://wiki.openraildata.com//index.php?title=C5C52024-01-09T12:38:57Z<p>RhysGlover: Add routes 6001 to 6005, 6005 to 6021, 6008 to 6004 and 6024 to 6008</p>
<hr />
<div>===C5 - WROC North Wales Coast WestCAD===<br />
<br />
Below is a list of the signal data decodes that have been worked out. Please feel free to add to this. <br />
<br />
{| class="wikitable"<br />
! Address:Bit <br />
! Element type <br />
! Description<br />
|-<br />
| 00:0 <br />
| Route<br />
| 6001 to 6005<br />
|-<br />
| 00:1 <br />
| Route<br />
| 6005 to 6021<br />
|-<br />
| 00:2 <br />
| <br />
| <br />
|-<br />
| 00:3 <br />
| <br />
| <br />
|-<br />
| 00:4 <br />
| <br />
| <br />
|-<br />
| 00:5 <br />
| Route<br />
| 6008 to 6004<br />
|-<br />
| 00:6 <br />
| <br />
| <br />
|-<br />
| 00:7 <br />
| Route <br />
| 6021 to 6035<br />
|-<br />
| 01:0 <br />
| Route<br />
| 6024 to 6008<br />
|-<br />
| 01:1 <br />
| Route <br />
| 6035 to 6053<br />
|-<br />
| 01:2 <br />
| <br />
| <br />
|-<br />
| 01:3 <br />
| <br />
| <br />
|-<br />
| 01:4 <br />
| <br />
| <br />
|-<br />
| 01:5 <br />
| <br />
| <br />
|-<br />
| 01:6 <br />
| <br />
| <br />
|-<br />
| 01:7 <br />
| <br />
| <br />
|-<br />
| 02:0 <br />
| <br />
| <br />
|-<br />
| 02:1 <br />
| Route <br />
| 6040 to 6024<br />
|-<br />
| 02:2 <br />
| <br />
| <br />
|-<br />
| 02:3 <br />
| <br />
| <br />
|-<br />
| 02:4 <br />
| <br />
| <br />
|-<br />
| 02:5 <br />
| <br />
| <br />
|-<br />
| 02:6 <br />
| <br />
| <br />
|-<br />
| 02:7 <br />
| <br />
| <br />
|-<br />
| 03:0 <br />
| Route <br />
| 6044 to 6040<br />
|-<br />
| 03:1 <br />
| <br />
| <br />
|-<br />
| 03:2 <br />
| <br />
| <br />
|-<br />
| 03:3 <br />
| <br />
| <br />
|-<br />
| 03:4 <br />
| Route <br />
| 6053 to 6069<br />
|-<br />
| 03:5 <br />
| <br />
| <br />
|-<br />
| 03:6 <br />
| Route <br />
| 6056 to 6044<br />
|-<br />
| 03:7 <br />
| <br />
| <br />
|-<br />
| 04:0 <br />
| Route <br />
| 6066 to 6056<br />
|-<br />
| 04:1 <br />
| Route <br />
| 6069 to 6079<br />
|-<br />
| 04:2 <br />
| Route <br />
| 6079 to 6091<br />
|-<br />
| 04:3 <br />
| Route <br />
| 6079 to 6093<br />
|-<br />
| 04:4 <br />
| <br />
| <br />
|-<br />
| 04:5 <br />
| <br />
| <br />
|-<br />
| 04:6 <br />
| <br />
| <br />
|-<br />
| 04:7 <br />
| <br />
| <br />
|-<br />
| 05:0 <br />
| <br />
| <br />
|-<br />
| 05:1 <br />
| Route <br />
| 6084 to 6066<br />
|-<br />
| 05:2 <br />
| <br />
| <br />
|-<br />
| 05:3 <br />
| <br />
| <br />
|-<br />
| 05:4 <br />
| <br />
| <br />
|-<br />
| 05:5 <br />
| <br />
| <br />
|-<br />
| 05:6 <br />
| <br />
| <br />
|-<br />
| 05:7 <br />
| <br />
| <br />
|-<br />
| 06:0 <br />
| Route <br />
| 6091 to 6109<br />
|-<br />
| 06:1 <br />
| Route <br />
| 6093 to 6109<br />
|-<br />
| 06:2 <br />
| <br />
| <br />
|-<br />
| 06:3 <br />
| <br />
| <br />
|-<br />
| 06:4 <br />
| Route <br />
| 6098 to 6084<br />
|-<br />
| 06:5 <br />
| Route <br />
| 6106 to 6098<br />
|-<br />
| 06:6 <br />
| Route <br />
| 6109 to LJ49<br />
|-<br />
| 06:7 <br />
| <br />
| <br />
|-<br />
| 07:0 <br />
| <br />
| <br />
|-<br />
| 07:1 <br />
| <br />
| <br />
|-<br />
| 07:2 <br />
| <br />
| <br />
|-<br />
| 07:3 <br />
| <br />
| <br />
|-<br />
| 07:4 <br />
| <br />
| <br />
|-<br />
| 07:5 <br />
| <br />
| <br />
|-<br />
| 07:6 <br />
| <br />
| <br />
|-<br />
| 07:7 <br />
| <br />
| <br />
|-<br />
| 08:0 <br />
| Signal <br />
| 6001<br />
|-<br />
| 08:1 <br />
| Signal <br />
| 6005<br />
|-<br />
| 08:2 <br />
| Signal <br />
| 6004<br />
|-<br />
| 08:3 <br />
| <br />
| <br />
|-<br />
| 08:4 <br />
| <br />
| <br />
|-<br />
| 08:5 <br />
| Signal <br />
| 6008<br />
|-<br />
| 08:6 <br />
| Signal <br />
| 6021<br />
|-<br />
| 08:7 <br />
| Signal <br />
| 6024<br />
|-<br />
| 09:0 <br />
| Signal <br />
| 6035<br />
|-<br />
| 09:1 <br />
| <br />
| <br />
|-<br />
| 09:2 <br />
| <br />
| <br />
|-<br />
| 09:3 <br />
| Signal <br />
| 6040<br />
|-<br />
| 09:4 <br />
| <br />
| <br />
|-<br />
| 09:5 <br />
| <br />
| <br />
|-<br />
| 09:6 <br />
| Signal <br />
| 6044<br />
|-<br />
| 09:7 <br />
| <br />
| <br />
|-<br />
| 0A:0 <br />
| Signal <br />
| 6053<br />
|-<br />
| 0A:1 <br />
| <br />
| <br />
|-<br />
| 0A:2 <br />
| Signal <br />
| 6056<br />
|-<br />
| 0A:3 <br />
| <br />
| <br />
|-<br />
| 0A:4 <br />
| Signal <br />
| 6066<br />
|-<br />
| 0A:5 <br />
| Signal <br />
| 6069<br />
|-<br />
| 0A:6 <br />
| Signal <br />
| 6079<br />
|-<br />
| 0A:7 <br />
| <br />
| <br />
|-<br />
| 0B:0 <br />
| <br />
| <br />
|-<br />
| 0B:1 <br />
| Signal <br />
| 6084<br />
|-<br />
| 0B:2 <br />
| <br />
| <br />
|-<br />
| 0B:3 <br />
| <br />
| <br />
|-<br />
| 0B:4 <br />
| Signal <br />
| 6091<br />
|-<br />
| 0B:5 <br />
| Signal <br />
| 6093<br />
|-<br />
| 0B:6 <br />
| <br />
| <br />
|-<br />
| 0B:7 <br />
| Signal <br />
| 6098<br />
|-<br />
| 0C:0 <br />
| Signal <br />
| 6106<br />
|-<br />
| 0C:1 <br />
| Signal <br />
| 6109<br />
|-<br />
| 0C:2 <br />
| <br />
| <br />
|-<br />
| 0C:3 <br />
| <br />
| <br />
|-<br />
| 0C:4 <br />
| <br />
| <br />
|-<br />
| 0C:5 <br />
| <br />
| <br />
|-<br />
| 0C:6 <br />
| <br />
| <br />
|-<br />
| 0C:7 <br />
| <br />
| <br />
|}<br />
Note - This list uses standard SOP-style numbering, i.e. bit 0 for the LSB to bit 7 for the MSB of each byte.<br />
<br />
{{Navtable-DataFeeds}}<br />
<br />
[[Category:Train Describer Data]]<br />
[[Category:S Class Messages]]</div>RhysGloverhttps://wiki.openraildata.com//index.php?title=National_Rail_Data_PortalNational Rail Data Portal2023-12-18T01:03:59Z<p>EvelynSnow: More information, examples</p>
<hr />
<div>The '''National Rail Data Portal''' is National Rail's data platform, through which users can subscribe to [[HSP]], [[Darwin:Push_Port|Darwin]], [[DTD]], and [[KnowledgeBase]]. The platform is capable of delivering CIGP (''Customer Information GPS Platform'') and CTI (''Connecting Train Identifiers''); these APIs and feeds aren't currently available to open data users.<br />
<br />
Only the Knowledgebase API and DTD are available directly through NRDP's API, the other subscriptions (including real-time KB incidents) are accessed externally, using the information included in the ''My Feeds'' tab.<br />
<br />
New users can register using the [https://opendata.nationalrail.co.uk/registration registration form] on https://opendata.nationalrail.co.uk/<br />
<br />
= CIGP and CTI =<br />
CIGP (''Customer Information GPS Platform''), also referred to as TLMS (''Train Location Monitoring System''), locates services physically using GPS data provided by train operators, CTI (''Connecting Train Identifiers'') corresponds services to the specific trains which run them. These were first announced in the Joint Rail Data Action Plan in 2018,<ref>https://www.gov.uk/government/publications/joint-rail-data-action-plan/joint-rail-data-action-plan-addressing-barriers-to-make-better-use-of-rail-data#annex-a-list-of-rdgs-future-data-releases - Joint Rail Data Action Plan (Annex A) (2018)</ref>, and went live with version 3 of the NRDP in early 2019<ref>https://groups.google.com/g/openraildata-talk/c/0jqtX-Se3mo/m/xzB-bwyZAwAJ - NRDP Phase 3 Live (2019)</ref>, but neither has been made available to open data users, owing to operator reluctance and security concerns.<ref>https://groups.google.com/g/openraildata-talk/c/6FH9doR_O_w/m/TZSpXbJ4DAAJ - Train GPS data (2019)</ref> CIGP and CTI both have API and real-time components<ref>https://opendata.nationalrail.co.uk/main.2fe5da105724f586305e.js - NRDP "main" javascript file, col 360696 and 361613 (CIGP), col 362535 and 363445 (CTI)</ref>, but no documentation has been published on either.<br />
<br />
= Authentication =<br />
To authenticate, POST to https://opendata.nationalrail.co.uk/authenticate with form parameters "username" and "password" set accordingly - the request must be urlencoded, and not multipart.<br />
<br />
For example, if the username was <code>alice@example.com</code>, and the password was <code>hunter2%^</code>, the request would look like this:<br />
<pre><br />
POST /authenticate HTTP/1.1<br />
Host: opendata.nationalrail.co.uk<br />
Content-Type: application/x-www-form-urlencoded<br />
Content-Length: 51<br />
<br />
username=alice%40example.com&password=hunter2%25%5E<br />
</pre><br />
<br />
Using curl:<br />
<pre><br />
curl 'https://opendata.nationalrail.co.uk/authenticate' \<br />
--data-urlencode 'username=alice@example.com' \<br />
--data-urlencode 'password=hunter2%^'<br />
</pre><br />
<br />
Successful authentication should yield a JSON object with three keys.<br />
* <code>username</code> is self-explanatory.<br />
* <code>roles</code> contains only the roles your account has, this example is missing <code>ROLE_DTD</code> and <code>ROLE_HSP_USER</code>, because the user is not subscribed to them.<br />
* <code>token</code> is your authentication token, which includes your username, the time the token will expire (expressed in milliseconds since the UNIX epoch), and finally the secret. <br />
<pre><br />
{<br />
"username":"alice@example.com",<br />
"roles":<br />
{<br />
"ROLE_DARWIN":true,<br />
"ROLE_KB_REAL_TIME":true,<br />
"ROLE_STANDARD":true,<br />
"ROLE_KB_API":true<br />
},<br />
"token":"alice@example.com:1702858757000:JAlA9FAzcdFAfDAZX8a1JYIsXaa4uFNDI0qaePaXRQA="<br />
}<br />
</pre><br />
<br />
If the username or password are invalid:<br />
<pre><br />
{"error":"Invalid username/password"}<br />
</pre><br />
<br />
= Authenticating requests =<br />
<br />
The token should be supplied in full with each request made to NRDP in the <code>X-Auth-Token</code> header, e.g.<br />
<pre><br />
curl 'https://opendata.nationalrail.co.uk/api/staticfeeds/2.0/routeing' \<br />
-H 'X-Auth-Token: alice@example.com:1702858757000:JAlA9FAzcdFAfDAZX8a1JYIsXaa4uFNDI0qaePaXRQA=' \<br />
--output routeing.zip<br />
</pre><br />
<br />
If the token is expired or invalid, instead of the routeing zip:<br />
<pre><br />
{<br />
"timestamp": "2023-12-18T00:56:23.284+0000",<br />
"status": 401,<br />
"error": "Unauthorized",<br />
"message": "Unauthorized",<br />
"path": "/api/staticfeeds/2.0/routeing"<br />
}<br />
</pre><br />
<br />
= Endpoints =<br />
== NRDP ==<br />
All NRDP endpoints return JSON<br />
<br />
=== https://opendata.nationalrail.co.uk/api/feeds ===<br />
Contents of the feeds page, including feed URLs and credentials<br />
<br />
=== https://opendata.nationalrail.co.uk/api/feeds/available ===<br />
Available feeds, not user-specific, but platform-wide. Doesn't offer any information that isn't already a given.<br />
* <code>"DARWIN"</code> - Darwin<br />
* <code>"DTD"</code> - Fares, Routeing Guide and Timetable data<br />
* <code>"KB_API"</code> - Knowledgebase (KB) API<br />
* <code>"KB_REAL_TIME"</code> - Knowledgebase (KB) Real Time Incidents<br />
* <code>"HSP"</code> - Historical Service Performance (HSP)<br />
* <code>"CIGP_API"</code> - Customer Information GPS Platform (CIGP) API<br />
* <code>"CIGP_REAL_TIME"</code> - Customer Information GPS Platform (CIGP) Real Time Feed<br />
* <code>"CTI_API"</code> - Connecting Train Identifiers (CTI) API<br />
* <code>"CTI_REAL_TIME"</code> - Connecting Train Identifiers (CTI) Real Time Feed<br />
<br />
Example<br />
<pre>["DTD","KB_API","KB_REAL_TIME","DARWIN","HSP"]</pre><br />
<br />
=== https://opendata.nationalrail.co.uk/api/user ===<br />
Can be used to either get (GET) or update (POST) user information, the same JSON object is used for both, simply set the changed values (e.g. to enable HSP in the below example, set "hspUser" to true)<br />
<br />
Example<br />
<pre><br />
{<br />
"telephone":"",<br />
"cigpApiUser":false,<br />
"cigpRealTimeUser":false,<br />
"ctiApiUser":false,<br />
"ctiRealTimeUser":false,<br />
"darwinUser":true,<br />
"dtdUser":false,<br />
"hspUser":false,<br />
"kbApiUser":true,<br />
"kbRealTimeUser":true,<br />
"business":null,<br />
"email":"alice@example.com",<br />
"name":"Alice Smith",<br />
"plannedUsage":"",<br />
"usageDetails":<br />
{<br />
"website":"https://example.com/~alice/ldb",<br />
"screens":"",<br />
"researchAndDevelopment":"",<br />
"applications":"",<br />
"software":"AliceLDB",<br />
"dataFeedIntegration":"",<br />
"other":""<br />
}<br />
}<br />
</pre><br />
<br />
== DTD ==<br />
All [[DTD]] feeds are ZIP files<br />
<br />
* https://opendata.nationalrail.co.uk/api/staticfeeds/2.0/fares<br />
* https://opendata.nationalrail.co.uk/api/staticfeeds/2.0/routeing<br />
* https://opendata.nationalrail.co.uk/api/staticfeeds/3.0/timetable<br />
<br />
== KB API ==<br />
All [[KnowledgeBase|KB]] API feeds are XML<br />
<br />
* https://opendata.nationalrail.co.uk/api/staticfeeds/4.0/serviceIndicators<br />
* https://opendata.nationalrail.co.uk/api/staticfeeds/5.0/incidents<br />
* https://opendata.nationalrail.co.uk/api/staticfeeds/4.0/tocs<br />
* https://opendata.nationalrail.co.uk/api/staticfeeds/4.0/ticket-restrictions<br />
* https://opendata.nationalrail.co.uk/api/staticfeeds/4.0/ticket-types<br />
* https://opendata.nationalrail.co.uk/api/staticfeeds/4.0/promotions-publics<br />
* https://opendata.nationalrail.co.uk/api/staticfeeds/4.0/stations<br />
<br />
= References =<br />
<references /><br />
<br />
{{Navtable-NreDataFeeds}}<br />
[[Category:National Rail Enquiries Data Feeds]]</div>EvelynSnow