Skip to main content
RideShare provides a complete backend API for ride-sharing applications. With it you can authenticate users, book rides, get fare estimates, process payments via Razorpay, find nearby drivers, and send in-app notifications — all through a clean REST interface.

Quick Start

Make your first API call in minutes. Sign up, get a token, and book a ride.

Authentication

Learn how to sign up with OTP, log in, and use JWT tokens to authorize requests.

Ride Booking

Estimate fares, book rides, and track status from request to completion.

API Reference

Full reference for all public endpoints with request and response examples.

Get started in four steps

1

Request an OTP

Send your email to POST /auth/signup/request-otp to receive a one-time passcode.
2

Create your account

Submit your name, email, password, and OTP to POST /auth/signup to create an account.
3

Log in and get your token

Call POST /auth/login to receive a JWT access token and a refresh token.
4

Start making requests

Pass Authorization: Bearer <access-token> on every authenticated request.

Key features

Fare Estimation

Get price estimates before booking based on distance, ride type, and route preference.

Real-time Drivers

Find available drivers near any coordinate using the live driver location index.

Payments

Create Razorpay payment orders, verify signatures, and check session status.

Notifications

Receive and manage in-app notifications for ride events and updates.