metro-route-sdk 0.1.1

Official Python SDK for the Metro Route Premium API.

Metro Route SDK (Python)

The official, highly optimized Python client library for the Metro Route Premium API. This SDK provides seamless, programmatic access to real-time data, station information, and journey planning for both the Delhi Metro (DMRC) and the Noida Metro (NMRC).

🚀 Installation

pip install metro-route-sdk

💻 Quick Start

This SDK provides both a standard synchronous client (MetroRouteClient) and an asynchronous client (AsyncMetroRouteClient) for modern, high-performance web frameworks like FastAPI.

Asynchronous Example (Recommended)

import asyncio
from metro_route import AsyncMetroRouteClient

async def main():
    async with AsyncMetroRouteClient() as client:
        # Get all operating lines in Delhi
        lines = await client.get_lines()
        print(f"Found {len(lines)} metro lines!")

        # Plan a journey on the Noida Metro Aqua Line
        journey = await client.plan_nmrc_journey(from_station_id="1", to_station_id="16")
        print(f"Fare: ₹{journey['fare']}, Stations: {journey['stations_count']}")

asyncio.run(main())

Synchronous Example

from metro_route import MetroRouteClient

client = MetroRouteClient()
details = client.get_station_details("RG") # Rajiv Chowk
print(details)
client.close()

---

📚 Full API Reference

Both MetroRouteClient and AsyncMetroRouteClient expose the exact same methods (the async version just requires await).

🚆 Delhi Metro (DMRC) Endpoints

1. get_lines()

Fetches a list of all currently operating Delhi Metro lines, including their hex colors and terminal stations.

• Returns: List[dict]

2. get_stations_by_line(line_code: str)

Retrieves every station on a specific line sequentially.

• Parameters:
  • line_code (str): The identifier for the line (e.g., "YELLOW", "BLUE").
• Returns: List[dict]

3. search_stations(name: str)

Fuzzy-searches for stations matching the given name query.

• Parameters:
  • name (str): Search term (e.g., "Rajiv").
• Returns: List[dict]

4. get_station_details(station_code: str)

Retrieves comprehensive details about a specific station, including gates, platforms, and interchange information.

• Parameters:
  • station_code (str): The station's unique code (e.g., "RG" for Rajiv Chowk).
• Returns: dict

5. plan_journey(from_station: str, to_station: str)

Calculates the optimal route between two DMRC stations, providing the exact fare, travel time, and a step-by-step path including interchanges.

• Parameters:
  • from_station (str): Starting station code.
  • to_station (str): Destination station code.
• Returns: dict

6. get_notifications()

Fetches the latest official alerts, delays, and notifications directly from DMRC.

• Returns: List[dict]

---

🚊 Noida Metro (NMRC) Endpoints

7. get_nmrc_stations()

Fetches all operational stations on the Noida Metro Aqua Line.

• Returns: List[dict]

8. plan_nmrc_journey(from_station_id: str, to_station_id: str)

Calculates the fare and route for a journey entirely within the Aqua Line network.

• Parameters:
  • from_station_id (str): Numeric string ID of the starting station (e.g., "1" for Sector 51).
  • to_station_id (str): Numeric string ID of the destination station.
• Returns: dict

⚙️ Configuration

By default, the client points to the live production server. You can override the base_url during initialization if you are hosting the API yourself:

client = MetroRouteClient(base_url="http://localhost:8000/api/v2")