API – trajektoria linii

Informacje o geograficznym przebiegu linii komunikacji miejskiej.

Zwracane są informacje wyłącznie dla linii, które danego dnia realizują kursy – i jedynie dla wariantów tras obowiązujących w danym dniu. Reset danych następuje każdego dnia o godz. 4:00.

• Endpoint: GET https://www.zditm.szczecin.pl/api/v1/trajectories/{lineId} (wartość parametru {lineId} można uzyskać korzystając z API dla linii – pole id)
• Typ danych: application/json (GeoJSON)
• Częstotliwość aktualizacji: raz na dobę

Struktura danych

{
  "type": "FeatureCollection",
  "attributes": {
    "line_id": 1,
    "line_number": "1",
    "line_type": "day",
    "line_subtype": "normal",
    "vehicle_type": "tram",
    "updated_at": "2023-06-02T19:29:07.463152Z"
  },
  "features": [
    {
      "type": "Feature",
      "properties": {
        "route_variant_number": 11,
        "route_variant_type": "default"
      },
      "geometry": {
        "type": "LineString",
        "coordinates": [
          [
            14.4884117153,
            53.4571634728
          ],

          ...

        ]
      }
    },

    ...

  ]
}

• string type – zawsze wartość FeatureCollection
• object attributes – obiekt zawierający informacje na temat danej linii komunikacji miejskiej
  • int line_id – identyfikator linii (niezmienny)
  • string line_number – oznaczenie (numer) linii (może ulegać zmianom)
  • string line_type – typ linii:
    • day – linia dzienna
    • night – linia nocna
  • string line_subtype – podtyp linii:
    • normal – linia zwykła
    • semi-fast – linia przyspieszona
    • fast – linia pospieszna
    • replacement – linia zastępcza
    • additional – linia dodatkowa
    • special – linia specjalna
    • tourist – linia turystyczna
  • string vehicle_type – rodzaj trakcji:
    • skm – pociąg SKM
    • tram – tramwaj
    • bus – autobus
  • string updated_at – moment ostatniej aktualizacji danych
• array features – tablica zawierająca przebieg poszczególnych tras linii
  • string type – zawsze wartość Feature
  • object properties – obiekt zawierający informacje na temat danej trasy
    • int route_variant_number – numer trasy dla linii (liczba nieparzysta oznacza kierunek TAM, a liczba parzysta – kierunek POWRÓT)
    • string route_variant_type – typ trasy:
      • default – trasa domyślna (podstawowa)
      • normal – trasa zwykła
      • other – trasa inna (dojazd lub zjazd do zajezdni)
  • object geometry – obiekt zawierający trajektorię danej trasy
    • string type – zawsze wartość LineString
    • array coordinates – tablica zawierająca współrzędne geograficzne kolejnych punktów trasy (długość geograficzna, szerokość geograficzna)

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. Zalecane jest podanie źródła danych, tj. Zarząd Dróg i Transportu Miejskiego w Szczecinie lub – w formie skróconej – ZDiTM Szczecin.
3. Zalecane jest – jeżeli jest to możliwe – umieszczenie odsyłacza do niniejszej strony lub do strony głównej.
4. Klient powinien rozpoznawać i honorować nagłówki HTTP Cache-Control i ETag.
5. 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.
6. 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).
7. W przypadku nadmiernego obciążania serwera ZDiTM Szczecin zastrzega sobie prawo do częściowego lub całkowitego zablokowania dostępu do API.