> ## Documentation Index
> Fetch the complete documentation index at: https://rideshare.docs.sumit-dhondikar.in/llms.txt
> Use this file to discover all available pages before exploring further.

# RideShare API

> Build ride-sharing experiences with a powerful backend API for booking rides, processing payments, and tracking drivers in real time.

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.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Make your first API call in minutes. Sign up, get a token, and book a ride.
  </Card>

  <Card title="Authentication" icon="lock" href="/authentication">
    Learn how to sign up with OTP, log in, and use JWT tokens to authorize requests.
  </Card>

  <Card title="Ride Booking" icon="car" href="/guides/booking-a-ride">
    Estimate fares, book rides, and track status from request to completion.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/auth/request-otp">
    Full reference for all public endpoints with request and response examples.
  </Card>
</CardGroup>

## Get started in four steps

<Steps>
  <Step title="Request an OTP">
    Send your email to `POST /auth/signup/request-otp` to receive a one-time passcode.
  </Step>

  <Step title="Create your account">
    Submit your name, email, password, and OTP to `POST /auth/signup` to create an account.
  </Step>

  <Step title="Log in and get your token">
    Call `POST /auth/login` to receive a JWT access token and a refresh token.
  </Step>

  <Step title="Start making requests">
    Pass `Authorization: Bearer <access-token>` on every authenticated request.
  </Step>
</Steps>

## Key features

<CardGroup cols={2}>
  <Card title="Fare Estimation" icon="calculator" href="/guides/booking-a-ride">
    Get price estimates before booking based on distance, ride type, and route preference.
  </Card>

  <Card title="Real-time Drivers" icon="location-dot" href="/api-reference/rides/nearby-drivers">
    Find available drivers near any coordinate using the live driver location index.
  </Card>

  <Card title="Payments" icon="credit-card" href="/concepts/payments">
    Create Razorpay payment orders, verify signatures, and check session status.
  </Card>

  <Card title="Notifications" icon="bell" href="/guides/notifications">
    Receive and manage in-app notifications for ride events and updates.
  </Card>
</CardGroup>