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

Get the ride detail of a given ride ID

GET
/rides/{id}
User
Get the status of a ride along with information about the driver, vehicle and price of a given ride ID
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.lyft.com/v1/rides/'
Response Response Example
200 - Example 1
{
  "beacon_color": "#FFFFFF",
  "destination": {
    "address": "987 Second St, Anytown, CA",
    "lat": 36.9453452,
    "lng": -123.8642521
  },
  "distance_miles": 16.2,
  "driver": {
    "first_name": "Joe",
    "image_url": "http://example.com/lyft.png",
    "phone_number": "+15554445111",
    "rating": "4.9"
  },
  "dropoff": {
    "address": "987 Second St, Anytown, CA",
    "lat": 36.9453452,
    "lng": -123.8642521,
    "time": "2023-08-15T05:38:32.975Z"
  },
  "duration_seconds": 1620,
  "line_items": [
    {
      "amount": 500,
      "currency": "USD",
      "type": "Ride"
    },
    {
      "amount": 250,
      "currency": "USD",
      "type": "Prime Time"
    },
    {
      "amount": 155,
      "currency": "USD",
      "type": "Service fee"
    }
  ],
  "location": {
    "address": "987 Second St, Anytown, CA",
    "lat": 36.9453452,
    "lng": -123.8642521
  },
  "origin": {
    "address": "123 Main St, Anytown, CA",
    "lat": 36.9442175,
    "lng": -123.8679133
  },
  "passenger": {
    "first_name": "Jane",
    "phone_number": "+15554445000",
    "user_id": "776630198662493392"
  },
  "pickup": {
    "address": "123 Main St, Anytown, CA",
    "lat": 36.9442175,
    "lng": -123.8679133,
    "time": "2023-08-15T05:38:32.975Z"
  },
  "price": {
    "amount": 905,
    "currency": "USD",
    "description": "Total ride price"
  },
  "primetime_percentage": "50%",
  "requested_at": "2023-08-15T05:38:32.975Z",
  "ride_id": 123456789,
  "ride_profile": "personal",
  "ride_type": "lyft",
  "status": "droppedOff",
  "vehicle": {
    "color": "black",
    "image_url": "http://example.com/lyft.png",
    "license_plate": "AAAAAAA",
    "make": "Audi",
    "model": "A4"
  }
}

Request

Path Params
id
string 
required
The ID of the ride

Responses

🟢200Detailed ride information including ride status, driver information, passenger information, vehicle information, location information and price
application/json
Body
Detail information about a ride
beacon_color
string 
optional
Hex color code of the driver AMP device.
can_cancel
array[string]
optional
Allowed values:
driverpassengerdispatcher
canceled_by
string 
optional
The role of user who canceled the ride (if applicable)
cancellation_price
object  | allOf {1} 
optional
The cost of cancellation if there would be a penalty
#/components/schemas/CancellationCost
optional
Could not resolve '#/components/schemas/CancellationCost'
destination
object  | allOf {1} 
optional
The requested location for passenger drop off
#/components/schemas/RideLocation
optional
Could not resolve '#/components/schemas/RideLocation'
distance_miles
number <float>
optional
The distance, in miles, that this ride traveled. This field is only present after drop-off
driver
object (DriverDetail) 
optional
Example:
{"first_name":"Joe","image_url":"http://example.com/lyft.png","phone_number":"+15554445000","rating":"4.9","user_id":"123456789"}
first_name
string 
required
The driver's first name
image_url
string 
required
The driver's image url
phone_number
string <phone>
required
The driver's contact phone number. Must be E.164 formatted.
rating
string 
required
The driver's rating based in 0-5 scale
user_id
string 
required
The driver's id
dropoff
object  | allOf {1} 
optional
The actual location of passenger drop off
#/components/schemas/PickupDropoffLocation
optional
Could not resolve '#/components/schemas/PickupDropoffLocation'
duration_seconds
integer <int32>
optional
Duration of the ride in seconds from pickup to drop-off. This field is only present after drop-off.
feedback
string 
optional
The written feedback the user left for this ride
generated_at
string <date-time>
optional
The request timestamp in date and time
line_items
array[object (LineItem) {3}] 
optional
The break down of cost
amount
integer <int32>
required
The line item amount
currency
string 
required
The currency for the amount
type
string 
required
The line item display name for a charge item
location
object  | allOf {1} 
optional
The current location info of the ride
#/components/schemas/CurrentRideLocation
optional
Could not resolve '#/components/schemas/CurrentRideLocation'
origin
object  | allOf {1} 
optional
The requested location for passenger pickup
#/components/schemas/RideLocation
optional
Could not resolve '#/components/schemas/RideLocation'
passenger
object (PassengerDetail) 
optional
Example:
null
first_name
string 
required
The passenger's first name
image_url
string 
required
The passenger's profile image
rating
string 
required
The passenger's rating
last_name
string 
optional
The passenger's last name
user_id
string 
optional
The passenger's lyft user id
pickup
object  | allOf {1} 
optional
The actual location of passenger pickup
#/components/schemas/PickupDropoffLocation
optional
Could not resolve '#/components/schemas/PickupDropoffLocation'
price
object  | allOf {1} 
optional
The total price for the current ride
#/components/schemas/Cost
optional
Could not resolve '#/components/schemas/Cost'
pricing_details_url
string 
optional
The web view showing the pricing structure for the geographic area where the ride was taken
primetime_percentage
string 
optional
The Prime Time percentage applied to the base price
rating
integer <int32>
optional
The rating the user left for this ride, from 1 to 5
requested_at
string <date-time>
optional
The ride requested timestamp in date and time
ride_id
string 
optional
The unique ID of this ride
ride_profile
object  | allOf {1} 
optional
Indicates whether the ride was requested from the business profile or personal profile of the user.
#/components/schemas/RideProfileEnum
optional
Could not resolve '#/components/schemas/RideProfileEnum'
ride_type
enum<string> 
optional
The ID of the ride type
Allowed values:
lyftlyft_linelyft_pluslyft_premierlyft_luxlyft_luxsuvother
route_url
string 
optional
The web view showing the passenger, driver, and route for this ride. This field will only be present for rides created through this API, or that have been shared through the "Share my Route" feature
status
enum<string> 
optional
The status of the ride
Allowed values:
pendingacceptedarrivedpickedUpdroppedOffcanceledscheduledunknown
vehicle
object (VehicleDetail) 
optional
Example:
{"color":"black","image_url":"http://example.com/lyft.png","license_plate":"AAAAAAA","license_plate_state":"CA","make":"Audi","model":"A4","year":2016}
color
string 
required
The vehicle's color
image_url
string 
required
The vehicle's image url
license_plate
string 
required
The vehicle's license plate
license_plate_state
string 
required
The vehicle's license plate state
make
string 
required
The vehicle's maker
model
string 
required
The vehicle's model
year
integer <int32>
required
The vehicle's model year
🟠403User or client does not have permission to complete this request
🟠404No ride found with provided ride ID
Modified at 2023-08-15 05:38:33
Previous
Request a Lyft
Next
Cancel a ongoing requested ride
Built with