Search
This method provides availability information with the cheapest fare option available. The request includes single query. When properly submitted, the Search Response returns the available option.
Once the requested query is parsed and validated, the booking engine starts searching for the best option. If the search is successful it will return Result object.
Bus Search Test API Notice:Please note that the test API may occasionally fail to return results. If this happens, please try again after a short while. For more consistent and reliable results during testing, we recommend using the Bangalore (19402) to Hyderabad (8875) route, as it typically returns data successfully.
Service URL (REST) to be used:
Search Request
| Level | Element | Format | Comments | Mandatory |
|---|---|---|---|---|
| 1 | ClientId | String | Unique client identifier assigned to the agency during registration and API onboarding. Used for request authentication and tracking. | Mandatory |
| 2 | UserName | String | Authorized API username issued to the agency for authentication and access to bus booking services. | Mandatory |
| 3 | Password | String | Secure API password associated with the registered username. Required for request validation and authorization. | Mandatory |
| 4 | FromCityCode | Integer | Unique city code representing the origin city from which the passenger intends to start the journey (e.g., 8875 for Bhubaneswar). | Mandatory |
| 5 | ToCityCode | Integer | Unique city code representing the destination city to which the passenger intends to travel (e.g., 19402 for Baripada). | Mandatory |
| 6 | DepartDate | Date Time | Date of travel for the bus search request. Must be provided in YYYY-MM-DD format (e.g., 2025-07-19). | Mandatory |
Search Response
| Level | Element | Format | Comments | Mandatory |
|---|---|---|---|---|
| 1 | Error{} | Object | Contains error information related to the request processing. This object is returned in both successful and failed responses. | Mandatory |
| 1.1 | ErrorCode | Integer | Numeric error code indicating the status of the request. A value of 0 typically indicates successful processing. | Mandatory |
| 1.2 | ErrorMessage | String | Contains error description corresponding to ErrorCode. Error Message would be blank in case ErrorCode = 0. | Mandatory |
| 2 | TraceId | Integer | Unique transaction identifier generated for the search request. Used for tracking, auditing, and troubleshooting purposes. | Mandatory |
| 3 | Result[] | Array | Collection of available bus services matching the search criteria. Each item contains detailed information about a specific bus. | Mandatory |
| 3.1 | SrdvIndex | Integer | Unique internal identifier assigned to the bus result by the API. Required for subsequent booking-related operations. | Mandatory |
| 3.2 | ResultIndex | String | Unique reference identifier for the specific bus search result. Used to identify the selected bus during the booking flow. | Mandatory |
| 3.3 | DepartureTime | Date Time | Preferred date time Format: yyyy-MM-dd TH HH:mm:ss (Define the bus departure date time.) | Mandatory |
| 3.4 | ArrivalTime | Date Time | Preferred date time Format: yyyy-MM-dd TH HH:mm:ss (Approx. arrival time at the destination.) | Mandatory |
| 3.5 | Duration | Time | Duration of the journey in minutes | Mandatory |
| 3.6 | IsArrivingNextDay | Boolean | Define whether the bus is arriving the next day or not.(if arrivingNextDay is true the bus arrives the next day.) | Mandatory |
| 3.7 | AvailableSeats | String | Total number of seats currently available for booking on the selected bus service. | Mandatory |
| 3.8 | MaxSeatsPerTicket | String | Define maximum No. of seats can be booked in a single ticket. | Mandatory |
| 3.9 | RouteId | String | Unique identifier representing the bus route. | Mandatory |
| 3.10 | BusRoute | String | Route description indicating the origin and destination cities covered by the bus service. | Mandatory |
| 3.11 | BusType | String | Description of the bus configuration and amenities, such as AC Sleeper, Non-AC Seater, Volvo Multi-Axle, etc. | Mandatory |
| 3.12 | OperatorId | String | Unique identifier assigned to the bus operator. | Mandatory |
| 3.13 | TravelsName | String | Name of the bus operator or travel company providing the service. | Mandatory |
| 3.14 | Seater | Boolean | Indicates whether the bus offers seating accommodation. true = Seater bus, false = Not a seater bus. | Mandatory |
| 3.15 | Sleeper | Boolean | Indicates whether the bus offers sleeper berths. true = Sleeper bus, false = Non-sleeper bus. | Mandatory |
| 3.16 | MTicketEnabled | Boolean | Indicates whether mobile tickets (M-Tickets) are supported for this bus service. | Mandatory |
| 3.17 | IdProofRequired | Boolean | Specifies whether passengers must present a valid government-issued ID proof during boarding. | Mandatory |
| 3.18 | IsDropPointMandatory | Boolean | Indicates whether selecting a drop-off point is mandatory during the booking process. | Mandatory |
| 3.19 | IsAC | Boolean | Indicates whether the bus is equipped with air-conditioning facilities. | Mandatory |
| 3.20 | LiveTracking | Boolean | Indicates whether real-time bus tracking is available for passengers. | Mandatory |
| 3.21 | OTGEnabled | Boolean | Indicates whether onboard OTG charging facilities are available. | Mandatory |
| 3.22 | VaccinatedBus | Boolean | Indicates whether the bus has been sanitized and marked compliant with operator vaccination/safety protocols. | Mandatory |
| 3.23 | VaccinatedStaff | Boolean | Indicates whether the onboard staff has completed the operator's vaccination and safety compliance requirements. | Mandatory |
| 3.24 | BoardingPoints[] | Array | Collection of available boarding locations along with their respective pickup details and departure timings. | Mandatory |
| 3.24.1 | Id | String | Unique identifier assigned to the boarding point. | Mandatory |
| 3.24.2 | Name | String | Name of the boarding location where passengers can board the bus. | Mandatory |
| 3.24.3 | Address | String | Address of the boarding point (e.g. Baramunda Bus Terminus). | Mandatory |
| 3.24.4 | Location | String | Location of the boarding point (e.g.Baramunda Bus Terminus) . | Mandatory |
| 3.24.5 | Landmark | String | Landmark of the boarding point (e.g. near Baramunda Bus Terminus). | Mandatory |
| 3.24.6 | ContactNumber | String | Contact No. at Boarding Point. | Mandatory |
| 3.24.7 | Time | Time | Time of arrival at Boarding Point in HH:MM format. | Mandatory |
| 3.24.8 | IsPrime | Boolean | Define whether the Bus is prime. | Mandatory |
| 3.25 | DroppingPoints | Array[] | Array of dropping point detail like dropping point name and time. | Mandatory |
| 3.25.1 | Id | String | Index of the dropping point (e.g. 43289). | Mandatory |
| 3.25.2 | Name | String | Name of the dropping point at Source (e.g. Baramunda ) . | Mandatory |
| 3.25.3 | Address | String | Address of the dropping point (e.g. Baramunda Bus Terminus). | Mandatory |
| 3.25.4 | Location | String | Location of the dropping point (e.g. Baramunda Bus Terminus). | Mandatory |
| 3.25.5 | Landmark | String | Landmark of the dropping point (e.g. near Baramunda Bus Terminus). | Mandatory |
| 3.25.6 | ContactNumber | Integer | Contact No. at dropping Point. | Mandatory |
| 3.25.7 | Time | Time | Time of arrival at dropping Point in HH:mm format. | Mandatory |
| 3.25.8 | IsPrime | Boolean | Define whether the Bus is prime. | Mandatory |
| 3.26 | DisplayFare | Decimal | Total fare displayed to the customer for the selected bus service. | Mandatory |
| 3.27 | Price | Array[] | Contains the detailed fare breakdown including base fare, taxes, charges, discounts, and final payable amount. | Mandatory |
| 3.27.1 | CurrencyCode | String | ISO 4217 currency code in which fare values are returned (e.g., INR, USD). | Mandatory |
| 3.27.2 | BaseFare | String | Base transportation fare excluding taxes, service charges, and other applicable fees. | Mandatory |
| 3.27.3 | Tax | String | Total tax amount applicable to the booking, including GST and other government levies. | Mandatory |
| 3.27.4 | OtherCharges | String | Additional charges applied to the booking, such as service fees, convenience fees, or operator charges. | Optional |
| 3.27.5 | Discount | String | Total discount amount applied to the fare based on promotions, coupons, or special offers. | Optional |
| 3.27.6 | PublishedFare | String | Final fare before any discounts or commissions; usually BaseFare + Tax + OtherCharges
|
Mandatory |
| 3.27.7 | OfferedFare | Decimal | What the customer is expected to pay—a discounted fare or one extended through a special offer | Mandatory |
| 3.27.8 | AgentCommission | Decimal | Commission earned by the agent booking the ticket | Optional |
| 3.27.9 | MarkUp | String | Additional margin added on top of the fare by the reseller or agent | Optional |
| 3.27.10 | GstTaxableAmount | String | The amount on which GST is calculated (usually the Base Fare) | Optional |
| 3.27.11 | GstRate | String | The GST % rate applied | Optional |
| 3.27.12 | GstAmount | String | Calculated tax based on GstRate × GstTaxableAmount , often same as value
in Tax |
Optional |
| 3.28 | PartialCancellationAllowed | Boolean | Indicates if partial cancellation is allowed for the bus | Mandatory | 3.29 | CancellationPolicies | Array[] | Contains the cancellation rules defined by the bus operator. | Mandatory |
| 3.29.1 | CancellationCharge | String | The cancellation charge value depends on the CancellationChargeType; for example, if the charge is 100 and the type is Percentage, then 100% of the fare will be charged. | Mandatory |
| 3.29.2 | CancellationChargeType | String | Indicates the type of cancellation charge: - Percentage: The charge is a % of the fare
- Fixed: The charge is a fixed amount |
Mandatory |
| 3.29.3 | PolicyString | String | Human-readable explanation of the cancellation rule. Useful for showing to the end user directly on UI. | Mandatory |
| 3.29.4 | TimeBeforeDept | Time | The time window (in hours) before scheduled departure for which this cancellation rule applies.
Example: 12 means the rule applies from 0 to 12 hours before departure. |
Mandatory |
| 3.29.5 | FromDate | Date | The date from which the cancellation policy is applicable (usually the departure date). | Optional |