SL Realtidsinformation 4

Detta API kommer stängas ned vid slutet av mars 2024. Den ersätts av SLs nya transport API.

Beskrivning

Realtidsinformation gällande buss, tunnelbana, pendeltåg och lokalbana.

URL

https://api.sl.se/api2/realtimedeparturesV4.<FORMAT>?key=<DIN API NYCKEL>&siteid=<SITEID>&timewindow=<TIMEWINDOW>

API-nyckelnivåer

NivåMax anrop/minutMax anrop/månad
Brons3010 000
Silver60500 000
Silver +601 500 000
Guld10 000 000
Guld +30 000 000
PlatinaEfter behov

Format

Json eller xml enligt ändelse till serviceanropet.

Parametrar

ParametrarDatatypTvingandeBeskrivning
FormatStringJaFormat på svarsdatat. Giltiga värden är “json” eller “xml”.
SiteIdIntegerJaUnikt identifikationsnummer för den plats som aktuella avgångar skall hämtas för, t.ex. 9192 för Slussen. Detta id fås från tjänsten SL Platsuppslag.
TimeWindowIntegerJaHämta avgångar inom önskat tidsfönster. Där tidsfönstret är antalet minuter från och med nu. Max 60.
KeyStringJaEn giltig API-nyckel.
BusBooleanNejDefault = true. Om false, så exkluderas trafikslaget från svaret.
MetroBooleanNejDefault = true. Om false, så exkluderas trafikslaget från svaret.
TrainBooleanNejDefault = true. Om false, så exkluderas trafikslaget från svaret.
TramBooleanNejDefault = true. Om false, så exkluderas trafikslaget från svaret.
ShipBooleanNejDefault = false. Om true inkluderas information om osäker prognos.
EnablePredictionBooleanNejDefault = true. Om false, så exkluderas trafikslaget från svaret.

Resultat

Resultat från realtidssökning. Vid xml-format är rotelementets namn ResponseOfDepartures.

Svarsstruktur

NamnDatatypBeskrivning
StatusCodeIntegerInnehåller statuskod för det eventuella meddelandet.
MessageStringInnehåller eventuellt anropsrelaterade meddelanden som t.ex. felmeddelanden. Se ”Felmeddelanden” nedan.
ExecutionTimeLongAnger hur lång tid (i ms) det tog för servern att generera svaret.
ResponseDataDepartureInnehåller själva svarsdata från tjänsten. Se ”Svarsdata” nedan.

Svarsdata/ResponseData

NamnDatatypBeskrivning
LatestUpdateDateTimeAnger när realtidsinformationen (DPS) senast uppdaterades.
DataAgeIntegerAntal sekunder sedan tidsstämpeln LatestUpdate.
BusesListLista över samtliga bussavgångar för givet siteId, se svarsstruktur.
MetrosListLista över samtliga tunnelbaneavgångar för givet siteId, se svarsstruktur.
TrainsListLista över samtliga pendeltågsavgångar för givet siteId, se svarsstruktur.
TramsListLista över samtliga lokalbaneavgångar för givet siteId, se svarsstruktur.
ShipsListLista över samtliga båtavgångar för givet siteId, se svarsstruktur.
StopPointDeviationsListLista över hållplatsområdesspecifika avvikelser/störningar. D.v.s. störningar som inte är knutna till en specifik avgång.

Departure

NamnDatatypBeskrivning
TransportModeStringTrafikslag: ”BUS”,“METRO”, ”TRAIN”, ”TRAM” eller ”SHIP”.
LineNumberStringLinjebeteckning/nummer.
DestinationStringNamn på linjens ändhållplats.
JourneyDirectionIntegerReseriktnings-id. 0 vid okänd riktning, annars 1 eller 2.
GroupOfLineStringFör buss: Anger om det är en blå buss. Om det är en blå buss står det ”blåbuss”, annars saknas elementet(xml) eller är null(json). För lokalbana: Linjegrupp, t.ex. “Tvärbanan” eller “Roslagsbanan”. För tunnelbana: Linjegruppering. Röd/grön/blå linje. För båt: Anger om det är pendlarbåt eller Waxholmsbolaget.
StopAreaNameStringHållplatsnamn.
StopAreaNumberIntegerId för aktuell hållplats. Tunnelbana före övergång: 0.
StopPointNumberIntegerId för aktuellt stoppställe. Tunnelbana före övergång: 0.
StopPointDesignationStringYtterligare identifierare för stoppställe, t.ex. bokstav för busskur eller spår för pendeltåg.
TimeTabledDateTimeDateTimeAvgångstid enligt tidtabell.
ExpectedDateTimeDateTimeFörväntad avgångstid. Om det finns tillhörande störning med tillräckligt hög prioritet så kan denna ha null/tomt värde. Detta fram till ett par minuter innan avgång.
DisplayTimeStringAvgångstid för presentation. Kan anta formaten x min, HH:mm eller Nu. Om det finns tillhörande störning med tillräckligt hög prioritet så kan denna ha värdet ”-”. Detta fram till ett par minuter innan avgång.
JourneyNumberIntegerTurnummer för avgången.
DeviationsListInnehåller typen ”Deviation” nedan. Denna kan vara tom, eller innehålla 1 till flera avvikelser.
SecondaryDestinationNameStringFinns bara för: Pendeltåg. Namn på delmål.
PredictionStateStringKan ha tre olika värden, NORMAL, UNRELIABLE, UNKNOWN. UNRELIABLE betecknar en osäker prognos. Namn på delmål.

Deviation

NamnDatatypBeskrivning
ConsequenceStringKonsekvensbeskrivning för aktuell avvikelse.
ImportanceLevelIntegerSignifikationsnivå för aktuell avvikelse. 0-9 där 9 är mest allvarlig.
TextStringBeskrivning av aktuell avvikelse.

StopPointDeviations

NamnDatatypBeskrivning
StopInfoStopInfoStopInfo. Kan vara tom. Se StopInfo
DeviationDeviationDeviation. Kan vara tom. Se Deviation.

StopInfo

NamnDatatypBeskrivning
GroupOfLineStringOm TransportMode är ”TRAM” så innehåller noden något av följande värden: ”Lidingöbanan”, ”Nockebybanan”, ”Roslagsbanan”, ”Saltsjöbanan”, ”Spårväg City”, ”Tvärbanan”. Annars blankt (kan komma att ändras).
StopAreaNameStringNamn på hållplatsen som avvikelsen gäller.
StopAreaNumberIntegerId för hållplatsen som avvikelsen gäller. Är noll om TransportMode inte är BUS.
TransportModeString”METRO”, ”BUS”, ”TRAIN”, ”TRAM” eller ospecificerat.

Felmeddelanden

StatuskodMeddelande
1001Nyckel har ej skickats med.
1002Nyckel är ogiltig
1003Ogiltigt api
1004problem with request: This api is currently not available for keys with priority above 2
1005Nyckel finns, men ej för detta api
1006För många anrop per minut, för den profil som används
1007För många anrop per månad, för den profil som används
4001SiteId måste gå att konvertera till heltal.
5321Kunde varken hämta information från TPI (tunnelbanan) eller DPS (övriga trafikslag).
5322Kunde inte hämta information från DPS.
5323Kunde inte hämta information från TPI.
5324Kunde varken hämta information från TPI (tunnelbanan) eller DPS (övriga trafikslag) p.g.a. inaktuell DPS-data. Detta uppstår om DPS-datan är äldre än 2 minuter vid svarstillfället.

Support

Räcker inte dokumentationen så sök gärna bland alla de hundratals inlägg som finns på vårt supportforum. Det är troligt att någon redan har hittat och löst samma problem som du har.

Hittar du fortfarande inte svar på din fråga så skriv ett eget inlägg på forumetså hjälper vi dig.