About the National Rail Feeds: Difference between revisions
EvelynSnow (talk | contribs) temporary change in OpenLDBSV registration process |
EvelynSnow (talk | contribs) Unbreak broken links |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
The [https://www.raildeliverygroup.com/ Rail Delivery Group] (formerly known as Association of Train Operating Companies, or simply ATOC) under their [http://www.nationalrail.co.uk/ National Rail] brand provide a number of data feeds for passenger-facing information systems across the railway network. The [https://www.nationalrail.co.uk/ | The [https://www.raildeliverygroup.com/ Rail Delivery Group] (formerly known as Association of Train Operating Companies, or simply ATOC) under their [http://www.nationalrail.co.uk/ National Rail] brand provide a number of data feeds for passenger-facing information systems across the railway network. The [https://www.nationalrail.co.uk/developers/darwin-data-feeds/ developers page] on the NRE website provides information for the data feeds provided, some of which are free and some of which are chargeable. They also provide a summary of feeds they supply in the [https://assets.nationalrail.co.uk/e8xgegruud3g/2PHRyfp2mN2N0UUd6nyK0B/770a70c6c08296905136e2c1ef1ca06a/NRE_Feeds_Developer_Pack_v.01-05.pdf Feeds developer pack] | ||
Outages and faults with RDG's data feeds should be reported to the email addresses in the below table; these contacts should not be used for general inquiries or support. For general usage support on National Rail (and other open rail data), use the [https://groups.google.com/d/forum/openraildata-talk openraildata-talk] forum. | Outages and faults with RDG's data feeds should be reported to the email addresses in the below table; these contacts should not be used for general inquiries or support. For general usage support on National Rail (and other open rail data), use the [https://groups.google.com/d/forum/openraildata-talk openraildata-talk] forum. | ||
| Line 5: | Line 5: | ||
== Terms and Conditions == | == Terms and Conditions == | ||
* [https://opendata.nationalrail.co.uk/terms Developer Terms & Conditions (version 3)] | * [https://opendata.nationalrail.co.uk/terms Developer Terms & Conditions (version 3)] | ||
* [https:// | * [https://assets.nationalrail.co.uk/e8xgegruud3g/7yPy7gHJ7j3QZalp2zKZKJ/e32e5b871465c3a5f920e86cc07900d6/Developer_Guidelines_v_05-01.pdf Developer Guidelines (version 05.01)] | ||
* [https:// | * [https://assets.nationalrail.co.uk/e8xgegruud3g/3aKkEQ1sNtS25lD6o0fZdT/7cee7bcc2bed18c090ff6735e8b10e88/Usage_Charging_Document_v04-01.pdf Usage Charging Document (version 04-01)] | ||
* Attribution of NRE as the data source should be in line with the | * Attribution of NRE as the data source should be in line with the [https://assets.nationalrail.co.uk/e8xgegruud3g/5ebcjZTTKAptCTtnPfBi4V/22a3bd92a54a84a4f82720c38559e629/Brand_Guidelines_Logos_2.zip Brand Guidelines & Logos] | ||
==Freely available Feeds/APIs== | ==Freely available Feeds/APIs== | ||
| Line 49: | Line 49: | ||
==Registering for OpenLDBSV/Darwin Staff Webservice== | ==Registering for OpenLDBSV/Darwin Staff Webservice== | ||
OpenLDBSVWS has a [http://openldbsv.nationalrail.co.uk/ web registration process], this is currently (May 2023) broken, and cannot send registration verification emails. In the meantime, until the automatic registration process is fixed, RDG have established a procedure for manually creating accounts for the service. To request an account, send a completed [https:// | OpenLDBSVWS has a [http://openldbsv.nationalrail.co.uk/ web registration process], this is currently (May 2023) broken, and cannot send registration verification emails. In the meantime, until the automatic registration process is fixed, RDG have established a procedure for manually creating accounts for the service. To request an account, send a completed [https://assets.nationalrail.co.uk/e8xgegruud3g/3naKK7Qy2P4Rs6VYvyCCxJ/e54ddd40e85b5e2c5acf85702da8f554/Licence-Request-Form.pdf licence request form] to [mailto:nationalraildatafeeds@raildeliverygroup.com nationalraildatafeeds@raildeliverygroup.com], RDG staff will send you a license to sign, and then can provide you with account credentials. | ||
Note that the licence request form is generic, and is oriented more towards commercial data feeds users, but the eligibility criteria and license conditions for OpenLDBSV for open data feeds users remain the same as before. | Note that the licence request form is generic, and is oriented more towards commercial data feeds users, but the eligibility criteria and license conditions for OpenLDBSV for open data feeds users remain the same as before. | ||
==Licensed Feeds== | ==Licensed Feeds== | ||
NRE also provide a number of APIs from the Online Journey Planner service. Whilst anyone can request access to these APIs, due to contractual constraints NRE are currently unable to offer them without cost (and an associated license). More information can be found on the [https://www.nationalrail.co.uk/developers/online-journey-planner-data-feeds/ OJP feeds page] on NRE's site. | |||
NRE also provide a number of APIs from the Online Journey Planner service. Whilst anyone can request access to these APIs, due to contractual constraints NRE are currently unable to offer them without cost (and an associated license). More information can be found on the [ | |||
{| class="wikitable" | {| class="wikitable" | ||
| Line 64: | Line 63: | ||
|[[Real_Time_Journey_Planner|RTJP web service]] | |[[Real_Time_Journey_Planner|RTJP web service]] | ||
|SOAP API | |SOAP API | ||
| | |Formal license, charged | ||
|- | |- | ||
|Disruptions web service | |Disruptions web service | ||
|JSON API | |JSON API | ||
| | |Formal license, free of charge | ||
|- | |- | ||
|(What can I do with) My Ticket web service | |(What can I do with) My Ticket web service | ||
|JSON API | |JSON API | ||
| | |Formal license, charged | ||
|} | |} | ||
Latest revision as of 10:10, 8 June 2023
The Rail Delivery Group (formerly known as Association of Train Operating Companies, or simply ATOC) under their National Rail brand provide a number of data feeds for passenger-facing information systems across the railway network. The developers page on the NRE website provides information for the data feeds provided, some of which are free and some of which are chargeable. They also provide a summary of feeds they supply in the Feeds developer pack
Outages and faults with RDG's data feeds should be reported to the email addresses in the below table; these contacts should not be used for general inquiries or support. For general usage support on National Rail (and other open rail data), use the openraildata-talk forum.
Terms and Conditions
- Developer Terms & Conditions (version 3)
- Developer Guidelines (version 05.01)
- Usage Charging Document (version 04-01)
- Attribution of NRE as the data source should be in line with the Brand Guidelines & Logos
Freely available Feeds/APIs
| Feed | Type | Availability | Reporting faults |
|---|---|---|---|
| Darwin Webservice (Public) | SOAP API | Register | infoservices@nationalrail.co.uk |
| Darwin Webservice (Staff) | SOAP API | See below | infoservices@nationalrail.co.uk |
| Darwin Push Port | Pub/Sub stream | Register | dsg_darwind3.support@caci.co.uk |
| Historical Service Performance | JSON API | Register | dsg_darwind3.support@caci.co.uk |
| KnowledgeBase | XML Feed | Register | dsg_darwind3.support@caci.co.uk |
| DTD | Flat file feeds | Register | dsg_darwind3.support@caci.co.uk |
Registering for OpenLDBSV/Darwin Staff Webservice
OpenLDBSVWS has a web registration process, this is currently (May 2023) broken, and cannot send registration verification emails. In the meantime, until the automatic registration process is fixed, RDG have established a procedure for manually creating accounts for the service. To request an account, send a completed licence request form to nationalraildatafeeds@raildeliverygroup.com, RDG staff will send you a license to sign, and then can provide you with account credentials.
Note that the licence request form is generic, and is oriented more towards commercial data feeds users, but the eligibility criteria and license conditions for OpenLDBSV for open data feeds users remain the same as before.
Licensed Feeds
NRE also provide a number of APIs from the Online Journey Planner service. Whilst anyone can request access to these APIs, due to contractual constraints NRE are currently unable to offer them without cost (and an associated license). More information can be found on the OJP feeds page on NRE's site.
| Feed | Type | Availability |
|---|---|---|
| RTJP web service | SOAP API | Formal license, charged |
| Disruptions web service | JSON API | Formal license, free of charge |
| (What can I do with) My Ticket web service | JSON API | Formal license, charged |
| National Rail Enquiries Data Feeds | |
|---|---|
| Data Feeds | About the Feeds • Darwin Webservice (Public) • Darwin Webservice (Staff) • Historical Service Performance • Push Port • KnowledgeBase • DTD • Locations (PoC) • Real Time Journey Planner |
| LDB API | About |
| LDB-SV API | About |
| HSP | About |
| DTD | About • Fares • Timetable |
| Push Port | About • XML Schemas • Schedules • Associations • Train Status • Station Messages • Alarms • Train Order • Train Alerts • Formations • Formation loading |