HTTP API reference

GET /metro/stations

Paginated stations. At least one filter: line selector, network_type, q, or is_interchange.

Example request (query)

{
  "network_type": "metro",
  "q": "attaba",
  "locale": "ar",
  "page": 1,
  "per_page": 20
}

Example response

{
  "success": true,
  "message": "…",
  "data": [
    {
      "id": 12,
      "metro_line_id": 1,
      "stop_order": 5,
      "name_ar": "العتبة",
      "name_en": "Attaba",
      "is_full_show": true,
      "line": { "id": 1, "line_number": "2", "network_type": "metro" }
    }
  ],
  "meta": {
    "pagination": { "current_page": 1, "per_page": 20, "total": 1, "last_page": 1 }
  }
}

Also supported: include_connections=1, metro_line_id, line_ids[], line_number, line_sort_order + network_type.

GET /metro/stations/{id}

Single station; {id} = metro_stations.id.

Example request (query)

{
  "path": { "id": 12 },
  "query": { "locale": "ar" }
}

Example response

{
  "success": true,
  "message": "…",
  "data": {
    "id": 12,
    "name_ar": "…",
    "name_en": "Attaba",
    "connections": [],
    "tour_guide": null,
    "line": { "interchanges": [] }
  }
}

POST /metro/lines/stations

Full metro/LRT graph. Content-Type: application/json.

Example request (JSON body)

{
  "locale": "ar",
  "include_lrt": true,
  "lines": ["1", "2"]
}

Example response

{
  "success": true,
  "message": "…",
  "data": {
    "lines": [
      {
        "network": "metro",
        "line_number": "1",
        "name": "…",
        "color": "#ee2e24",
        "stations": [
          { "id": 1, "name": "…", "connections": [], "isFullShow": true }
        ],
        "interchange": []
      }
    ]
  }
}

GET /metro/routes

Same network for origin and destination. Text + planner names follow locale.

Example request (query)

{
  "origin_station_id": 1,
  "destination_station_id": 40,
  "locale": "ar"
}

Example response (data excerpt)

{
  "success": true,
  "message": "Metro route planned.",
  "data": {
    "locale": "ar",
    "line": "1",
    "number": "1",
    "station_count": 8,
    "ticket_price": 10,
    "ticket_currency": "EGP",
    "duration_minutes": 16,
    "distance": 8.2,
    "routeDescription": "…",
    "firstLineStations": [{ "id": 1, "name": "…", "connections": [], "isFullShow": true }],
    "secondLineStations": [],
    "interchangeStations": [],
    "transfers": [],
    "metro_service_window": {
      "timezone": "Africa/Cairo",
      "is_open_now": true,
      "message_ar": "…",
      "message_en": "…"
    },
    "journey_time": { "total_minutes": 14, "formatted_hh_mm": "00:14", "label_ar": "…" },
    "maps": {
      "travel_mode": "transit",
      "origin_coordinates": { "latitude": 30.05, "longitude": 31.24 },
      "destination_coordinates": { "latitude": 30.07, "longitude": 31.22 },
      "station_to_station_google_maps_url": "https://www.google.com/maps/dir/?api=1&origin=…&destination=…&travelmode=transit",
      "template_url": "https://www.google.com/maps/dir/?api=1&origin={origin_latlng}&destination={destination_latlng}&travelmode=transit",
      "placeholder_origin": "{origin_latlng}",
      "placeholder_destination": "{destination_latlng}",
      "hint_en": "…",
      "hint_ar": "…"
    }
  }
}

GET /metro/search/suggestions

Metro/LRT station name autocomplete.

Example request (query)

{
  "query": "sad",
  "locale": "ar",
  "page": 1,
  "per_page": 20
}

Example response

{
  "success": true,
  "message": "…",
  "data": [
    { "type": "metro_station", "id": 3, "name": "السادات" }
  ],
  "meta": { "suggestion_pool_size": 2, "pagination": { "current_page": 1, "per_page": 20, "total": 2, "last_page": 1 } }
}

GET /trains/search

Coordinates and/or stop ids (see table in catalog for combinations).

Example request (query)

{
  "origin": "30.05,31.24",
  "destination": "31.2,29.9",
  "page": 1,
  "per_page": 10,
  "locale": "ar"
}

Example response

{
  "success": true,
  "message": "…",
  "data": [
    {
      "type": "train",
      "train_id": 101,
      "stations": []
    }
  ],
  "meta": { "pagination": { "current_page": 1, "per_page": 10, "total": 3, "last_page": 1 } }
}

GET /trains/search/suggestions

Example request (query)

{ "query": "اسكندر", "page": 1, "per_page": 15 }

Example response

{
  "success": true,
  "data": [
    { "type": "train_city", "id": 5001, "name": "الإسكندرية" }
  ],
  "meta": { "pagination": { "current_page": 1, "per_page": 15, "total": 1, "last_page": 1 } }
}

GET /trains/by-id

Example request (query)

{ "train_id": 101 }

Example response

{
  "success": true,
  "data": {
    "train_id": 101,
    "stations": [{ "stop_id": 1, "city": "…", "departure_time": "08:00" }]
  }
}

Unknown id: "success": false, "code": "not_found".

GET /trains/routes/by-segment

Example request (query)

{
  "train_id": 101,
  "origin_stop_id": 10,
  "destination_stop_id": 25
}

Example response

{ "success": true, "data": { "train_id": 101, "stations": [] } }

GET /trains/schedules/between-stops

Example request (query)

{
  "origin_stop_id": 10,
  "destination_stop_id": 25,
  "train_type": "express",
  "page": 1,
  "per_page": 20
}

Example response

{
  "success": true,
  "data": [
    { "train_id": 101, "departure": "09:15", "arrival": "12:40" }
  ],
  "meta": { "pagination": { "current_page": 1, "per_page": 20, "total": 5, "last_page": 1 } }
}

GET /trains/metadata

facet required: ids | stop_ids | names | class.

Example request (query)

{ "facet": "stop_ids", "page": 1, "per_page": 30 }

Example response

{
  "success": true,
  "data": [5001, 5002, 5003],
  "meta": { "facet": "stop_ids", "pagination": { "current_page": 1, "per_page": 30, "total": 120, "last_page": 4 } }
}

GET /public-transport/places

Example request (query)

{ "page": 1, "per_page": 20, "include_station_graph": true }

Example response

{
  "success": true,
  "data": [
    { "id": 1, "name": "Place A", "connection_ids": [2, 3], "connections": ["Place B", "Place C"] }
  ],
  "meta": { "format": "station_graph", "pagination": { "current_page": 1, "per_page": 20, "total": 40, "last_page": 2 } }
}

GET /public-transport/routes

Example request (query)

{ "origin_place_id": 1, "destination_place_id": 8 }

Example response

{
  "success": true,
  "data": {
    "from": "Place A",
    "to": "Place B",
    "steps": [],
    "time": "25 min",
    "distance": 4.2
  }
}

GET /public-transport/search

Example request (query)

{
  "origin": "30.0,31.2",
  "destination_place_id": 5,
  "page": 1,
  "per_page": 10
}

Example response

{
  "success": true,
  "data": [
    { "type": "public_transport", "from": "…", "to": "…", "time": "20 min" }
  ],
  "meta": { "pagination": { "current_page": 1, "per_page": 10, "total": 2, "last_page": 1 } }
}

GET /public-transport/search/suggestions

Example request (query)

{ "query": "ram", "page": 1, "per_page": 20 }

Example response

{
  "success": true,
  "data": [
    { "type": "public_transport_place", "id": 3, "name": "Ramses" }
  ],
  "meta": { "pagination": { "current_page": 1, "per_page": 20, "total": 1, "last_page": 1 } }
}