API – tablice odjazdów
Informacje o najbliższych odjazdach z przystanku komunikacji miejskiej (wirtualna tablica).
- Endpoint:
GET https://www.zditm.szczecin.pl/api/v1/displays/{stopNumber}
(wartość parametru{stopNumber}
można uzyskać korzystając z API dla przystanków – polenumber
) - Typ danych: application/json
- Częstotliwość aktualizacji: co ok. 20 sekund
Struktura danych
{
"stop_name": "Brama Portowa",
"stop_number": "10813",
"departures": [
{
"line_number": "6",
"direction": "Gocław",
"time_real": 4,
"time_scheduled": null
},
...
],
"message": null,
"updated_at": "2023-06-02T20:18:08.522045Z"
}
- string
stop_name
– nazwa przystanku - string
stop_number
– numer przystanku - array
departures
– tablica zawierająca listę najbliższych odjazdów z przystanku- string
line_number
– oznaczenie (numer) linii - string
direction
– nazwa kierunku - int|null
time_real
– rzeczywisty czas do odjazdu w minutach (jeśli to pole nie zawiera wartościnull
, to poletime_scheduled
zawiera wartośćnull
) - string|null
time_scheduled
– rozkładowa godzina odjazdu w formaciehh:mm
(jeśli to pole nie zawiera wartościnull
, to poletime_real
zawiera wartośćnull
)
- string
- string|null
message
– komunikaty tekstowe umieszczone na tablicy - string
updated_at
– moment ostatniej aktualizacji danych
Informacje ogólne
- Dane udostępniane są bezpłatnie, do wykorzystania w dowolnym celu, a ich użycie nie wymaga wcześniejszego zgłoszenia.
- Zalecane jest podanie źródła danych, tj. Zarząd Dróg i Transportu Miejskiego w Szczecinie lub – w formie skróconej – ZDiTM Szczecin.
- Zalecane jest – jeżeli jest to możliwe – umieszczenie odsyłacza do niniejszej strony lub do strony głównej.
- Klient powinien rozpoznawać i honorować nagłówki HTTP
Cache-Control
iETag
. - Liczba żądań do API jest limitowana. Limit jest wspólny dla wszystkich endpointów i wynosi 6000 żądań na godzinę na adres IP. Nagłówek
X-RateLimit-Remaining
zawiera liczbę żądań pozostałych w ramach dostępnego limitu. Po wyczerpaniu limitu zwracany jest kod odpowiedzi HTTP429
. Nagłówek odpowiedziX-RateLimit-Reset
zawiera wówczas uniksowy timestamp równy czasowi zresetowania limitu, a nagłówekRetry-After
zawiera liczbę sekund pozostałych do zresetowania limitu. - Jeżeli to możliwe, w nagłówku
User-Agent
żądania należy umieścić informację o podmiocie korzystającym z danych (np. nazwa aplikacji, strony internetowej, adres URL). - W przypadku nadmiernego obciążania serwera ZDiTM Szczecin zastrzega sobie prawo do częściowego lub całkowitego zablokowania dostępu do API.