Lyft
  1. User
Lyft
  • Public
    • Cost estimates
      GET
    • Available drivers nearby
      GET
    • Pickup ETAs
      GET
    • Types of rides
      GET
  • User
    • The user's general info
      GET
    • List rides
      GET
    • Request a Lyft
      POST
    • Get the ride detail of a given ride ID
      GET
    • Cancel a ongoing requested ride
      POST
    • Update the destination of the ride
      PUT
    • Add the passenger's rating, feedback, and tip
      PUT
    • Get the receipt of the rides.
      GET
  • Sandbox
    • Preset Prime Time percentage
      PUT
    • Propagate ride through ride status
      PUT
    • Preset types of rides for sandbox
      PUT
    • Driver availability for processing ride request
      PUT
  1. User

Request a Lyft

POST
/rides
Request a Lyft come pick you up at the given location.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.lyft.com/v1/rides' \
--header 'Content-Type: application/json' \
--data-raw ''
Response Response Example
201 - Example 1
{
    "destination": {
        "address": "123 Main St, Anytown, CA",
        "lat": 36.9442175,
        "lng": -123.8679133
    },
    "origin": {
        "address": "123 Main St, Anytown, CA",
        "lat": 36.9442175,
        "lng": -123.8679133
    },
    "passenger": {
        "first_name": "Jane",
        "image_url": "https://public-api.lyft.com/static/images/user.png",
        "rating": 4.9,
        "user_id": "776630198662493392"
    },
    "ride_id": 123456789,
    "status": "pending"
}

Request

Body Params application/json

Examples

Responses

🟢201An object with high level ride information. Use `GET /v1/rides/{id}` for more details.
application/json
Body

🟠400The 'error' field can be one of the following: * `bad_parameter`: A validation error occurred * `no_service_in_area`: origin is not within a Lyft service area * `ridetype_unavailable_in_region`: ridetype not supported at origin * `primetime_confirmati
🟠403User or client does not have permission to complete this request. Specific errors include: * `user_payment_required`: The user does not have a valid payment method on file. They must use the Lyft app to add or update one. * `account_disabled`: The user
🟠409The 'error' field will be one of the following: * `no_drivers_available`: No drivers are available right now * `user_already_in_ride`: User cannot request a ride while in a ride
Modified at 2023-08-15 05:38:33
Previous
List rides
Next
Get the ride detail of a given ride ID
Built with