api.irail.be

Welcome to the iRail API! Before you start implementing this API, a lot of code has been written already! Feel free to look around on our Github page for more information on wrappers for your programming language of choice.

1. Query for station / download all stations

Request

https://irail.be/stations/NMBS?q={query}

Alternatively, you can check out our repo at https://github.com/iRail/stations for a CSV of all stations, and nodejs scripts to convert this CSV to other formats.

Another alternative is the deprecated https://api.irail.be/stations/ resource which takes no arguments at all.

Arguments

optional (leave empty for all stations):

?q=Brussel

Response

E.g., for Brussels: curl https://irail.be/stations/NMBS?q=Brussels
{
  "@graph": [
    {
      "@id": "http://irail.be/stations/NMBS/008811304",
      "alternative": [
        {
          "@language": "en",
          "@value": "Brussels-Luxemburg/Brussels-Luxembourg"
        },
        {
          "@language": "fr",
          "@value": "Bruxelles-Luxembourg"
        },
        {
          "@language": "nl",
          "@value": "Brussel-Luxemburg"
        }
      ],
      "name": "Brussel-Luxemburg/Bruxelles-Luxembourg",
      "latitude": "50.838943",
      "longitude": "4.373674"
    },
    ...
  ]
}

2. Querying for a route from one station to another

Request

https://api.irail.be/connections/?to={station1}&from={station2} (OPTIONAL:) &date={dmy}&time=2359&timeSel=arrive or depart

date

dmy (day of month with leading 0, number of the month with leading 0, 10 or 11 (for 2010 or 2011)) e.g., 010115 is the first of January 2015

time

Hours in 24 hour format concatenated with minutes with leading 0!

timeSel

Whether the date & time are for arrival or depart. Should be “arrive” or “depart”

Response

(with random data)

<connections>
  <connection id="0">
    <departure delay="xx"> <!--xx in seconds-->
      <station locationX="4.038586" locationY="50.943053">AALST</station>
      <time formatted="Y-m-d\TH:i:s\Z"> <!-- time in iso 8601 -->
        U <!--(= unixtime)-->
      </time>
      <vehicle>BE.NMBS.P2000</vehicle>
      <platform normal="yes">3</platform>
    </departure>
    <vias number="1">
      <via id="0">
        <arrival>
          <time formatted="Y-m-d\TH:i:s\Z">
            U<!--(= unixtime)-->
          </time>
          <platform>5</platform>
        </arrival>
        <depart>
          <time formatted="iso8601">
            U <!--(= unixtime)-->
          </time>
          <platform>6</platform>
        </depart>
        <timeBetween>xx</timeBetween>
        <station locationX="..." locationY="..." URI="...">Gent Sint Pieters</station>
        <vehicle>BE.NMBS.P2000</vehicle>
      </via>
    </vias>
    <arrival delay="xx"> <!--delay on arrival in seconds -->
      <station location="... ..." URI="...">
        Harelbeke
      </station>
      <time formatted="Y-m-d\TH:i\Z">
        U <!--(= unixtime)-->
      </time>
      <vehicle>BE.NMBS.P2000</vehicle>
      <platform normal="true">1</platform>
    </arrival>
    <duration delay="yes">seconds</duration>
  </connection>
  ...
</connections>

3. Departures and Arrivals in a certain station

Request

https://api.irail.be/liveboard/?station=STATIONNAME&fast=true
or
https://api.irail.be/liveboard/?id=BE.NMBS.008892007

fast

The direction of a train in the liveboard overview is not a station, but a general direction. The flag fast=true will omit trying to link a direction to a station. We recommend for the liveboard overview to always put fast=true.

station

Name of the station

id

id returned by a previous request

date

date of depart/arrival – dmy

time

time of depart/arrival –

arrdep

DEP or ARR for arrival or departure

Response

<liveboard version="1.0" timestamp="123456789">
 <station locationX="4.21485" locationY="...">Ghent Sint Pieters</station>
 <departures number="2">
  <departure delay="xx" id="0">
   <station locationX="..." locationY="...">STATIONNAME</station>
   <vehicle>Be.NMBS.P2000</vehicle>
   <time formatted="iso8601">U</time>
   <platform>X</platform>
  </departure>
  <departure delay="xx" id="1">
   <station locationX="..." locationY="...">STATIONNAME</station>
   <vehicle>BE.NMBS.P2001</vehicle>
   <time formatted="iso8601">U</time>
   <platform>X</platform>
  </departure>
 </departures>
</liveboard>

4. Vehicle

Request

https://api.irail.be/vehicle/?id=BE.NMBS.P1234

id

specify the vehicle id. This should be according the iRail specification

Response

 
<vehicleinformation version="1.1" timestamp="1469090808">
  <vehicle locationX="6.03711" locationY="50.635157">BE.NMBS.IC545</vehicle>
  <stops>
    <stop>
      <station id="BE.NMBS.008844628" locationX="6.03711" locationY="50.635157" 
          URI="http://irail.be/stations/NMBS/008844628" standardname="Eupen">Eupen</station>
      <platform normal="1">2</platform>
      <departureDelay>0</departureDelay>
      <departureCanceled>0</departureCanceled>
      <scheduledDepartureTime formatted="2016-07-21T22:22:00">1469132520</scheduledDepartureTime>
      <scheduledArrivalTime formatted="2016-07-21T22:22:00">1469132520</scheduledArrivalTime>
      <arrivalDelay>0</arrivalDelay>
      <arrivalCanceled>0</arrivalCanceled>
    </stop>
  ...
  </stops>
</vehicleinformation>

Error Response

When incorrect requests has been made or when an error occurs, we will provide an error message like this:

 <error version="1.0" timestamp="1289951590" code="1">
   You should ...
 </error>

at this moment code = 1 is a user error. code = 2 is a server error.

Arguments on all functions

lang

if you add &lang= NL, EN, DE or FR to a function, the given station will be interpreted in that language, and the stationnames will be outputted in that language.

format

Currently we support 2 formats: xml and json

  • &format=xml will output the above examples
  • &format=json will output the xml-converted json
  • &format=jsonp&callback=foo will package the json string into a callback function.

Alerts

setting alerts=true will enable alert messages in the response

Comments (19)

  1. Thanks for your efforts to implement this.
    The API https://irail.be/stations/NMBS does not seem to react to no parameters at all. Basically I’m looking for a list of all stations with Latitude and Longitude information.

    • Hi Vincent,

      Check https://github.com/iRail/stations for the raw data in CSV format. If you want the JSON file from the URL you’ve mentioned, you need to configure an Accept header with your request. E.g., “Accept: application/json” will return JSON. We have seen that this is not too straightforward and will soon add a GET parameter to retrieve JSON right away.

      Pieter

  2. Great innitiative :). Is there any way to check vehicle delay from a date in the past ?
    http://api.irail.be/vehicle/?id=BE.NMBS.P1234&fast=true&date= xxx ?

  3. The vehicle location seems to be set to the coordinates of the departure station whilst I would have expected to get its real position. Is that information available somewhere?

    With railtime, it was possible to see when a vehicle was arrived in (or had left) a specific station and this was really useful information. No App (SNCN / Railer) is showing this information.

    Thanks in advance for your answer.

  4. Vraagje, bij de request: http://api.irail.be/connections/?to={station1}&from={station2} Waarom station1 en station2 als gewone strings ipv ID van station? Wat als de stations van naam veranderen? Hoe gebeurt de encoding van deze strings?

  5. Why does “querying for a route from one station to another” use the dmy format and “fepartures and Arrivals in a certain station” the mdy format? BTW, love the api!

  6. Can we get station name from latitude and longitude ?

  7. Pingback: Stations ophalen wordt ook static dan maar… | De toekomst van digitale signalisatie

  8. Peter can you help ?

    We are looking for a system that show us the departures of all busses at uz jette, in a nice formatted way, as well from de lijn but also from the nivb.

    Because i’m not a prorammer, i’m not good at this.

    So could you write a php page that does this ?

    Thanx

    • I want to ask how i can make a page with the leaving times of bussess at jette hostpital.

      For mivb and de lijn.

      Can you help

  9. Hi,
    Some trains have one floor (quite old in general) and some two floors (comfortable, less crowded).

    Is it possible to identify from the API response the number of floors? Is this information encoded in the vehicle name (e.g. BE.NMBS.IC739) somehow?

    Thanks,
    Ignat.

  10. Een vraagje: ik probeer de real-time gtfs data van trip_updates.pb in te lezen in OpenTripPlanner, maar OpenTripPlanner crasht op het feit dat er geen trip_id ‘s in de data zitten. Dit is een dump van trip_updates.pb:

    trip {
    trip_id: “”
    start_date: “20160708”
    schedule_relationship: SCHEDULED
    route_id: “IC2009″
    }
    stop_time_update {
    stop_sequence: 0
    arrival {
    delay: 120
    time: 1467964440
    }
    stop_id: “8872009:1″
    }
    stop_time_update {
    stop_sequence: 1
    arrival {
    delay: 60
    time: 1467964860
    }
    stop_id: “8871100:3″
    }

    Het trip_id is dus inderdaad een lege string. Is dit de bedoeling? Indien ja, hoe kan men dan achterhalen over welke trip het precies gaat?
    Alvast bedankt!

  11. Pingback: Small enhancements of the API documentation | iRail

Leave a Reply