ResRobot Stop lookup

Obs: Detta innehåll finns inte tillgängligt på svenska. Därför ser du engelska versionen. Om du tycker att denna sida borde översättas till svenska, kan du skriva till oss på support.trafiklab.se.

Om du vill se webbsidan på engelska, klicka här.

What does this API provide?

ResRobot stop lookup provides information about stops, including their ids and position, by searching based on their name.

New version available

A new version, version 2.1, of ResRobot is available. Existing apps should migrate to the new version, and it is no longer possible to build new apps on version 2.0.

Version 2.0, which you are currently looking at, will be discontinued at June 30th, 2022.

Data format

The data is formatted as JSON or XML, depending on the format query parameter.

How often is this data updated?

The static data used for this API is updated when changes are made, at most once per day.

Which operators are covered by this dataset?

All operators which operate in Sweden are covered by the ResRobot APIs.

How often does the data format changes? Do breaking changes happen?

This API has the deprecated status and will be discontinued on June 30th 2022.

Using ResRobot Stop lookup

ResRobot Stop lookup takes the search string and the wanted number of results as parameters, and returns a list of matching stations with their location, name and id. Users can choose between exact matching and approximate matching by adding a question mark to the end of the search string.

Only the most important parameters and response variables are described on this page. Looking for more technical details? These can be found in the OpenAPI specification.

Instead of using the station lookup endpoint, you can also use the stops.txt file from GTFS Sverige 2. This way you can provide autocomplete and other search functions without internet access. It will make your application more responsive and more reliable as you don’t have to wait for API responses. See Combining data and APIs for more information.

New version available

A new version of ResRobot is available. Existing apps should migrate to the new version, and it is no longer possible to build new apps on version 2.0.

Example

Call

https://api.resrobot.se/v2/location.name?input=Göteborg&format=json&key=API_KEY

https://api.resrobot.se/v2/location.name?input=Göteborg&format=xml&key=API_KEY

Request parameters

Name	Type	Required	Description
key	String	Yes	Your API key
input	String	Yes	The search string. Append a question mark for fuzzy search.
maxNo	Integer	No	The maximum number of results to return, default 10, maximum 1000
lang	String	No	Language (sv/en/de), default sv. Affects both data (names for different transport types) and error messages.
format	String	No	Json or Xml

Fuzzy search

By adding a question mark to the query string, fuzzy matching is used instead of exact matching. This will return stations which name is an exact or near match to the input string.

Response

{
  "StopLocation": [
    {
      "id": "740098001",
      "extId": "740098001",
      "name": "GÖTEBORG",
      "lon": 11.973479,
      "lat": 57.708895,
      "weight": 22332,
      "products": 254
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<LocationList xmlns="hafas_rest_v1">
    <StopLocation id="740098001" extId="740098001" name="GÖTEBORG" lon="11.973479" lat="57.708895" weight="22332" products="254"/>
</LocationList>

All-caps stations, like GÖTEBORG in the example above, are virtual stations. These are a group of stations, for example to group stops which are close to eachother or to group several stops serving the same area. This is especially useful for people who are not familiar with the environment. Instead of having to choose between several stops which they don’t know, they can simply search for trips to “Göteborg”.

Response Data fields

Name	Data type	Description
LocationList	StopLocation[]	List with results
StopLocation	Object
name	String	Stop name
extId	String	Stop id for use in other ResRobot APIs.
id	String	Internal id. Do not use.
dist	Integer	Distance from the queried coordinates, in meters.
lat	String	Latitude (WGS84, decimal degree) for this stop, eg 59.293611
lon	String	Longitude (WGS84, decimal degree) for this stop, eg 18.083056
products	Integer	Transport modes available at thist stop, as a sum of the following values: 1 – Flyg 2 - Snabbtåg 4 - Tåg 8 - Expressbuss 16 - Lokaltåg 32 - Tunnelbana 64 – Spårvagn 128 – Buss 256 – Båt 512 – Taxi (160 – Tunnelbana och Buss)
weight	Integer	Shows how much traffic is handled at this stop, a stop with more traffic gets a higher weight. Between 0 and 32767.