Home

API Libellus (Castres-Mazamet)

Bienvenue sur une API proposant des données en temps réel sur les bus de l'agglomération de Castres-Mazamet

Auteur

• Nom: Alexis RARCHAERT
• Email: bonjour@alexis-rarchaert.fr
• Site Web: alexis-rarchaert.fr

Fonctionnalités

Statiques

• routes

  • Description: Récupère les lignes de bus
  • Méthode: GET
  • Endpoint: /routes/

• routeInfo

  • Description: Récupère les informations sur une ligne
  • Méthode: GET
  • Endpoint: /routes/:routeId

• shapes

  • Description: Récupère les shapes des bus
  • Méthode: GET
  • Endpoint: /shapes

• stopTimes

  • Description: Récupère les horaires de passage aux arrêts
  • Méthode: GET
  • Endpoint: /stop_times

• stops

  • Description: Récupère la liste de tous les arrêts
  • Méthode: GET
  • Endpoint: /stops

• trips

  • Description: Récupère la liste de tous les trajets
  • Méthode: GET
  • Endpoint: /trips

• calendar

  • Description: Récupère le calendrier de fonctionnement des bus
  • Méthode: GET
  • Endpoint: /calendar

• stopInfos

  • Description: Récupère les informations sur un arrêt
  • Méthode: GET
  • Endpoint: /stops/:stopId

• linesThroughStop

  • Description: Récupère les lignes passant par un arrêt
  • Méthode: GET
  • Endpoint: /stops/:stopId/lines

• stopsForTrip

  • Description: Récupère la liste de tous les arrêts d'un trajet
  • Méthode: GET
  • Endpoint: /trips/:tripId/stops

• tripDuration

  • Description: Récupère la durée d'un trajet de bus
  • Méthode: GET
  • Endpoint: /trips/:tripId/duration

• tripsThroughStop

  • Description: Récupère les trajets qui passent par un arrêt
  • Méthode: GET
  • Endpoint: /tripsThroughStop/:stopId

Dynamiques

• nextBusesStop

  • Description: Récupère les prochains bus à un arrêt (optionnel: date au format timestamp)
  • Méthode: GET
  • Endpoint: /stops/:stopId/nextBuses/:date

• gtfs-rt

  • Description: Récupère les données GTFS-RT brutes et les converti en JSON
  • Méthode: GET
  • Endpoint: /gtfs-rt

• delays

  • Description: Récupère les retards et avance des bus par rapport à l'horaire prévue
  • Méthode: GET
  • Endpoint: /delays

• generateLatePDF

  • Description: Génère un fichier PDF contenant les retards et les avances des bus de l'agglomération
  • Méthode: GET
  • Endpoint: /generateLatePDF

Exemple d'utilisation

curl https://api.libellus.alexis-rarchaert.fr/gtfs-rt

Installation

1. Cloner ce dépôt.
2. Installer les dépendances avec npm install.
3. Exécuter l'application avec node <nom_du_fichier>.
4. L'application sera disponible sur http://localhost:3000/.

Contribuer

1. Forker le dépôt.
2. Créer une branche (git checkout -b feature/nouvelle-fonctionnalite).
3. Commiter les changements (git commit -am 'Ajouter une nouvelle fonctionnalité').
4. Pousser la branche (git push origin feature/nouvelle-fonctionnalite).
5. Créer une Pull Request.