API – Linien

Dies ist die Dokumentation für Version 2 der API. Dokumentation für die veraltete Version 1.

Informationen zu den Linien des öffentlichen Nahverkehrs.

  • Endpoint: GET https://rozklad.renegades.at/api/v2/lines?format=json|cbor
  • Datenformat: application/json (Standard) oder application/cbor (wenn format=cbor)
  • Aktualisierungs­frequenz: nach Bedarf

Datenstruktur

{
  "data": [
    {
      "id": 1,
      "number": "1",
      "type": "DAY",
      "subtype": "NORMAL",
      "vehicle_type": "TRAM",
      "on_demand": false,
      "highlighted": false,
      "sort_order": 1,
      "updated_at": "2024-07-24T08:58:15.000000Z"
    },

    ...

  ]
}
  • int id – eindeutige Kennung der Linie (unveränderlich)
  • string number – Linienbezeichnung (Nummer) (kann sich ändern)
  • string type – Linie‑Typ:
    • DAY – Tageslinie
    • NIGHT – Nachtlinie
  • string subtype – Linien‑Untertyp:
    • NORMAL – normale Linie
    • SEMI_FAST – halb-schnelle Linie
    • FAST – Schnelllinie
    • REPLACEMENT – Ersatzlinie
    • ADDITIONAL – Zusatzlinie
    • SPECIAL – Sonderlinie
    • TOURIST – Touristenlinie
  • string vehicle_type – Fahrzeugtyp:
    • SKM – SKM‑Zug
    • TRAM – Straßenbahn
    • BUS – Bus
  • bool on_demand – true, wenn die Linie als Rufbussystem betrieben wird
  • bool highlighted – true, wenn die Linie in den Fahrgastinformationen orange hervorgehoben ist (geänderte Route oder Ersatzlinie)
  • int sort_order – Sortiernummer zur geordneten Darstellung der Linien (die Nummerierung muss nicht lückenlos sein)
  • string updated_at – Zeitstempel der letzten Datenaktualisierung

Allgemeine Informationen

  1. Die Daten werden kostenfrei unter der CC0 1.0‑Lizenz bereitgestellt und dürfen ohne vorherige Anmeldung für beliebige Zwecke genutzt werden.
  2. Der Zarząd Dróg i Transportu Miejskiego w Szczecinie (Straßen- und Stadtverkehrsverwaltung in Szczecin) übernimmt keine Gewähr für die Richtigkeit oder Vollständigkeit der Daten und haftet nicht für Schäden oder Fehlentscheidungen, die auf deren Basis getroffen werden.
  3. In Produkten, die die Daten verwenden (App, Website, Publikation o. Ä.), bitten wir um die Angabe der Datenquelle „Zarząd Dróg i Transportu Miejskiego w Szczecinie“ oder abgekürzt „ZDiTM Szczecin“, dies ist jedoch nicht gesetzlich vorgeschrieben.
  4. Ebenfalls optional, aber erwünscht: Ein Link zu dieser Webseite oder zur Hauptseite von ZDiTM Szczecin in Ihrem Produkt.
  5. Clients sollten die HTTP‑Header Cache-Control und ETag erkennen und beachten.
  6. Die Anzahl der API‑Anfragen ist begrenzt: Es sind 100 Anfragen pro Minute und IP‑Adresse über alle Endpunkte erlaubt. Der Header X-RateLimit-Remaining zeigt die verbleibenden Anfragen an. Nach Erreichen des Limits wird der HTTP‑Status 429 zurückgegeben. Der Header X-RateLimit-Reset enthält dann einen Unix‑Timestamp für die Rücksetzung des Limits, und der Header Retry-After gibt die verbleibenden Sekunden bis zur Rücksetzung an.
  7. Wenn möglich, fügen Sie im User-Agent‑Header Ihrer Anfragen einen Hinweis auf den nutzenden Dienst (z. B. Name der App, Website oder URL) hinzu.
  8. Bei übermäßiger Serverlast behält sich ZDiTM Szczecin das Recht vor, den API‑Zugang teilweise oder vollständig zu sperren.

Migration von Version 1

  1. Endpoint geändert auf: GET https://rozklad.renegades.at/api/v2/lines.
  2. Für die Felder type, subtype und vehicle_type hat sich das Format der zurückgegebenen Werte geändert – sie werden nun in der Schreibweise UPPER_SNAKE_CASE zurückgegeben.
  3. Zusätzlich wird das CBOR-Format (application/cbor) über den Parameter format=cbor unterstützt.