Request a Lyft

Request a Lyft come pick you up at the given location.

{ "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

Represents a requested, ongoing, or finished Lyft ride

cost_token

string

optional

A token that confirms the user has accepted current Prime Time and/or fixed price charges

destination

object | allOf {1}

optional

The requested location for passenger drop off

#/components/schemas/Location

optional

origin

object | allOf {1}

required

The requested location for passenger pickup

#/components/schemas/Location

optional

primetime_confirmation_token

string

optional

A token that confirms the user has accepted current primetime charges (Deprecated)

ride_type

enum<string>

required

The ID of the ride type

Allowed values:

lyftlyft_linelyft_pluslyft_premierlyft_luxlyft_luxsuv

Examples

Responses

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

application/json

Body

Minimal set of ride details

destination

object | allOf {1}

optional

The requested location for passenger drop off

#/components/schemas/Location

optional

origin

object | allOf {1}

optional

The requested location for passenger pickup

#/components/schemas/Location

optional

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

ride_id

string

optional

The ID of the requested ride

status

enum<string>

optional

The status of the ride

Allowed values:

pendingacceptedarrivedpickedUpdroppedOffcanceledscheduledunknown

🟠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