Get RATP data from RATP API.
Project description
RatpAPI Python Wrapper
Overview
RatpAPI is a Python wrapper for interacting with the RATP (Régie Autonome des Transports Parisiens) API. This library provides easy access to real-time traffic information, line-specific traffic details, and affluence data for journeys on the RATP network in Paris.
Features
- Fetch global traffic information on the RATP network.
- Retrieve traffic information for specific lines.
- Get affluence data for journeys on particular lines.
Installation
To use RatpAPI in your project, you can clone this repository:
pip install ratp-api-python
Usage
Setting Up
First, import the RatpAPI
class and initialize it with your API key:
from ratp_api.main import RatpAPI
api = RatpAPI()
Fetching Global Traffic Information
To get global traffic data:
global_traffic = api.get_global_traffic()
print(global_traffic)
Fetching Line-Specific Traffic
To get traffic information for a specific line:
line_traffic = api.get_line_traffic("line_id_here")
print(line_traffic)
Fetching Affluence for Journeys
To get affluence data for a specific journey on a line:
start_coords = (longitude, latitude) # Start location coordinates
end_coords = (longitude, latitude) # End location coordinates
line_id = "line_id_here"
affluence_data = api.get_affluence(start=start_coords, end=end_coords, line_id=line_id)
print(affluence_data)
Fetching Affluence for All Lines
To get affluence data for all lines:
all_lines_affluence = api.get_all_lines_affluence()
print(all_lines_affluence)
Contributing
Contributions to the RatpAPI project are welcomed!
License
This project is licensed under MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.