Get Bus Routes Endpoint

Retrieves the bus routes available on Syticks. It can also be customized to filter out exact information using query parameters.

Example of bus routes are Lagos->Abuja, Abuja->Kaduna, Awka-> Benin.

Note that, to get all Lagos->Abuja routes, you have to pass Lagos' city ID as the from_city_id as you can see below and Abuja's city ID as the to_city_id. Doing this will fetch you all the transport companies that ply that route.

So, if there are 4 companies that ply that route, it will return 4 items in the list, then if you pass in a business_id in the query param, it will return only the route of that particular business that you have specified.

To get the ID of any city, go to the 'Get all Cities' Endpoint.

Fetch All Bus Routes

get

This endpoint allows users to search for routes between cities and filter by price and business using query parameters. It provides flexibility for users to search for routes based on their travel needs. Filtering by origin, destination, price, and business allows for targeted searches.

Query parameters

searchstringOptional

Search for routes by city name, state name, or address. Returns routes matching the search criteria in origin or destination.

Example: Lagos

from_city_idintegerOptional

Filter routes departing from a specific city by its unique ID.

to_city_idintegerOptional

Filter routes arriving in a specific city by its unique ID.

pricestringOptional

Filter routes by price. You can specify a range using commas (e.g., price=100,200).

business_idintegerOptional

Filter routes by a specific business offering the route (e.g., bus company).

Responses

200

List of bus routes.

application/json

successbooleanOptional

Indicates whether the request was successful.

Example: true

statusintegerOptional

HTTP status code representing the response status.

Example: 200

messagestringOptional

Human-readable description of the response.

Example: List of bus routes

400

Bad request due to invalid input parameters.

application/json

404

No routes found matching the criteria.

application/json

500

Internal server error.

application/json

get

/api/v2/merpi/transport/routes

HTTPcURLJavaScriptPython

GET /api/v2/merpi/transport/routes HTTP/1.1
Accept: */*

{
  "success": true,
  "status": 200,
  "message": "List of bus routes",
  "data": {
    "routes": [
      {
        "id": 10,
        "price": 2625,
        "schedule_type": "timed",
        "price_breakdown": {
          "ticket_price": 2500,
          "convenience_fee": 50,
          "merchant_commission": 75
        },
        "from": {
          "address": "Unizk Junction, TempSite Awka, Anambra",
          "city": {
            "id": 2,
            "name": "Ekwulobia",
            "state": {
              "id": 4,
              "name": "Anambra"
            }
          }
        },
        "to": {
          "address": "Mikin Hill, Oba, Enugu",
          "city": {
            "id": 4,
            "name": "Iyanya",
            "state": {
              "id": 37,
              "name": "Federal Capital Territory"
            }
          }
        },
        "terminal": {
          "id": 7,
          "name": "Terminal One",
          "address": "698 Rocky Brook Cv, Cordova, TN 38018",
          "location": "Anambra",
          "slug": "terminal-one"
        },
        "business": {
          "id": "6e9d9432-2a1d-4a8a-a5e4-3ddfaf832523",
          "name": "User One",
          "photo": "https://dev.syticks.com/storage/profilePhotos/qOeJ9GsAEhTuCu7xaCNXMgzLyJtKhLgGxQwSuy7U.jpg",
          "slug": "user-one",
          "type": "bus"
        }
      },
      {
        "id": 42,
        "price": 31.5,
        "schedule_type": "random",
        "price_breakdown": {
          "ticket_price": 30,
          "convenience_fee": 0.6,
          "merchant_commission": 0.9
        },
        "from": {
          "address": "Achivers school, unity Avenue",
          "city": {
            "id": 2,
            "name": "Ekwulobia",
            "state": {
              "id": 4,
              "name": "Anambra"
            }
          }
        },
        "to": {
          "address": "Oke ureje",
          "city": {
            "id": 9,
            "name": "Owerri",
            "state": {
              "id": 16,
              "name": "Imo"
            }
          }
        },
        "terminal": {
          "id": 12,
          "name": "Onitsha Terminal",
          "address": "Onitsha main market",
          "location": "Anambra",
          "slug": "onitsha-terminal"
        },
        "business": {
          "id": "26838f1e-b6c2-43e7-9dd4-3409512fff64",
          "name": "Good Ride",
          "photo": "https://dev.syticks.com/storage/profilePhotos/hdwLJbfhtSWvfcibcHePKCbZ87bL2xnSkaENgsVw.jpg",
          "slug": "good-ride",
          "type": "bus"
        }
      }
    ],
    "next_page": null,
    "count": 2,
    "per_page": 20
  }
}