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 – pole number)
  • 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ści null, to pole time_scheduled zawiera wartość null)
    • string|null time_scheduled – rozkładowa godzina odjazdu w formacie hh:mm (jeśli to pole nie zawiera wartości null, to pole time_real zawiera wartość null)
  • string|null message – komunikaty tekstowe umieszczone na tablicy
  • string updated_at – moment ostatniej aktualizacji danych

Informacje ogólne

  1. Dane udostępniane są bezpłatnie, do wykorzystania w dowolnym celu, a ich użycie nie wymaga wcześniejszego zgłoszenia.
  2. Zarząd Dróg i Transportu Miejskiego w Szczecinie nie gwarantuje, że udostępniane dane są prawidłowe i kompletne. Nie ponosi również odpowiedzialności za szkody lub niewłaściwe decyzje podjęte na ich podstawie.
  3. W produkcie korzystającym z danych (aplikacja, strona internetowa, publikacja itp.) zalecane jest podanie źródła danych, tj. Zarząd Dróg i Transportu Miejskiego w Szczecinie lub – w formie skróconej – ZDiTM Szczecin.
  4. W produkcie korzystającym z danych (aplikacja, strona internetowa, publikacja itp.) zalecane jest – jeżeli jest to możliwe – umieszczenie odsyłacza do niniejszej strony lub do strony głównej.
  5. Klient powinien rozpoznawać i honorować nagłówki HTTP Cache-Control i ETag.
  6. 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 HTTP 429. Nagłówek odpowiedzi X-RateLimit-Reset zawiera wówczas uniksowy timestamp równy czasowi zresetowania limitu, a nagłówek Retry-After zawiera liczbę sekund pozostałych do zresetowania limitu.
  7. 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).
  8. W przypadku nadmiernego obciążania serwera ZDiTM Szczecin zastrzega sobie prawo do częściowego lub całkowitego zablokowania dostępu do API.