logo
theme
UberRide
FREE
UberRide Overview

Connect to the Uber API to request an Uber ride from within your app. Test an API call in your browser and export the code snippet directly into your app.

Uber's API has a sandbox and paid mode as of 3/1/2017: https://developer.uber.com/docs/riders/references/api

provider
rating
Followers on API
Follow this API
resourcesProvider WebsiteTerms of Service
More Details

UberRide

UberRide Package

Request an Uber or Uber delivery all from within your app.

How to get credentials:

  1. Go to the Uber developers area
  2. Sign in or Log in
  3. Register an UberRide app.

Custom datatypes:

Datatype Description Example
Datepicker String which includes date and time 2016-05-28 00:00:00
Map String which includes latitude and longitude coma separated 50.37, 26.56
List Simple array ["123", "sample"]
Select String with predefined values sample
Array Array of objects [{"Second name":"123","Age":"12","Photo":"sdf","Draft":"sdfsdf"},{"name":"adi","Second name":"bla","Age":"4","Photo":"asfserwe","Draft":"sdfsdf"}]

UberRide.getAccessToken

Generate Access Token.

Field Type Description
clientId credentials The Client ID obtained from Uber.
clientSecret credentials The Client Secret obtained from Uber.
code String The authorization code obtained from Uber API.
redirectUri String The URI we will redirect back to after an authorization by the resource owner. The base of the URI must match the redirect_uri used during the registration of your application.

UberRide.getUser

The User Profile endpoint returns information about the Uber user that has authorized with the application.

Field Type Description
accessToken String The valid access token.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.getUserActivity

The User Activity endpoint returns a limited amount of data about a user’s lifetime activity with Uber. The response will include pickup and dropoff times, the city the trips took place in, the distance of past requests, and information about which products were requested.

Field Type Description
accessToken String The valid access token.
offset Number Optional: Offset the list of returned results by this amount. Default is zero.
limit Number Optional: Number of items to retrieve. Default is 5, maximum is 50.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.getProductDetails

The Products Detail endpoint returns information about a specific Uber product. The response includes the display name and other details about the product.

Field Type Description
accessToken String The valid access token.
productId String Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.getCurrentRide

The Ride Request endpoint allows retrieving real-time details for an ongoing trip.

Field Type Description
accessToken String The valid access token.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.getRide

The Ride Request endpoint allows retrieving the status of an ongoing or completed trip that was created by your app.

Field Type Description
accessToken String The valid access token.
requestId String Unique identifier representing a Request.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.getProductsByLocation

The Products endpoint returns information about the Uber products offered at a given location. The response includes the display name and other details about each product, and lists the products in the proper display order. Some products, such as uberEATS, are not returned by this endpoint.

Field Type Description
accessToken String The valid access token.
coordinates Map Latitude and longitude component of location.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.getProductsPrices

The Price Estimates endpoint returns an estimated price range for each product offered at a given location. The price estimate is provided as a formatted string with the full price range and the localized currency symbol.

Field Type Description
accessToken String The valid access token.
startCoordinates Map Latitude and longitude component of start location.
endCoordinates Map Latitude and longitude component of end location.
seatCount String Optional: The number of seats required for uberPOOL. Default and maximum value is 2.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.getProductsTimeEstimates

The Time Estimates endpoint returns ETAs for all products currently available at a given location, with the ETA for each product expressed as integers in seconds.

Field Type Description
accessToken String The valid access token.
startCoordinates Map Latitude and longitude component of start location.
productId String Optional: Unique identifier representing a specific product for a given latitude & longitude.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.getUserAddress

The Places endpoint allows retrieving the home and work addresses from an Uber user's profile.

Field Type Description
accessToken String The valid access token.
placeName String The name of the place to retrieve. Only home and work are acceptable.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.updateUserAddress

The Places endpoint allows updating the home and work addresses from an Uber user's profile.

Field Type Description
accessToken String The valid access token.
placeName String The name of the place to retrieve. Only home and work are acceptable.
address String The address of the place that should be tied to the given placeName.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.getUserPaymentMethods

The Payment Methods endpoint allows retrieving the list of the user’s available payment methods.

Field Type Description
accessToken String The valid access token.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.createReminder

The Reminders endpoint allows developers to set a reminder for a future trip.

Field Type Description
accessToken String The valid access token. This endpoint only supports server_token.
reminderTime String Unix UTC timestamp of when the reminder will occur.
phoneNumber String Phone number of the individual to remind. Must be in the E.164 format.
eventTime String Unix UTC timestamp of the event time.
eventName String Optional: Formatted name of the event, which appears in the reminder notification. Alphanumeric up to 50 characters. Defaults to “Your event” if no name is provided.
eventLocation String Optional: Location of the event, which appears in the Uber app destination field. This does not need to be the entire address string since we rely on the event lat/long to set the destination pin, i.e., “Coit Tower” is sufficient instead of "Coit Tower, 1 Telegraph Hill Blvd, San Francisco, CA 94133".
eventLatitude String Optional: Latitude of the event location. Required to set destination pin.
eventLongitude String Optional: Longitude of the event location. Required to set destination pin.
eventProductId String Optional: Product ID of the Uber product to request. This overrides the product selected by the latitude / longitude pair. Required to set destination pin.
tripBrandingLinkText String Optional: Call-to-action text for the deeplink to your app. Used for trip branding and personalization.
tripBrandingPartnerDeeplink String Optional: Deeplink URL to a page in your app where your users can view relevant information and perform actions that will enhance the post-trip experience. Used for trip branding and personalization.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.getReminder

The Reminders endpoint allows you to get the status of an existing ride reminder.

Field Type Description
accessToken String The valid access token. This endpoint only supports server_token.
reminderId String The reminder ID.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.updateReminder

The Reminders endpoint allows you to update an existing reminder.

Field Type Description
accessToken String The valid access token. This endpoint only supports server_token.
reminderId String The reminder ID.
reminderTime String Unix UTC timestamp of when the reminder will occur.
phoneNumber String Phone number of the individual to remind. Must be in the E.164 format.
eventTime String Unix UTC timestamp of the event time.
eventName String Optional: Formatted name of the event, which appears in the reminder notification. Alphanumeric up to 50 characters. Defaults to “Your event” if no name is provided.
eventLocation String Optional: Location of the event, which appears in the Uber app destination field. This does not need to be the entire address string since we rely on the event lat/long to set the destination pin, i.e., “Coit Tower” is sufficient instead of "Coit Tower, 1 Telegraph Hill Blvd, San Francisco, CA 94133".
eventLatitude String Optional: Latitude of the event location. Required to set destination pin.
eventLongitude String Optional: Longitude of the event location. Required to set destination pin.
eventProductId String Optional: Product ID of the Uber product to request. This overrides the product selected by the latitude / longitude pair. Required to set destination pin.
tripBrandingLinkText String Optional: Call-to-action text for the deeplink to your app. Used for trip branding and personalization.
tripBrandingPartnerDeeplink String Optional: Deeplink URL to a page in your app where your users can view relevant information and perform actions that will enhance the post-trip experience. Used for trip branding and personalization.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.deleteReminder

The Reminders endpoint allows you to remove any reminder in the pending state from being sent.

Field Type Description
accessToken String The valid access token. This endpoint only supports server_token.
reminderId String The reminder ID.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.requestRide

The Ride Request endpoint allows a ride to be requested on behalf of an Uber user.

Field Type Description
accessToken String The valid access token.
startLatitude String The beginning or “pickup” latitude. Either this or startPlaceId must be specified.
startLongitude String The beginning or “pickup” longitude. Either this or startPlaceId must be specified.
endLatitude String The final or destination latitude. Either this or endPlaceId may be specified. If requesting POOL, this parameter is required.
endLongitude String The final or destination longitude. Either this or endPlaceId may be specified. If requesting POOL, this parameter is required.
startNickname String Optional: The beginning or “pickup” nickname label.
endNickname String Optional: The final or destination nickname label.
startAddress String Optional: The beginning or “pickup” address.
endAddress String Optional: The final or destination address.
productId String Optional: The unique ID of the product being requested. If none is provided, it will default to the cheapest product for the given location.
surgeConfirmationId String Optional: The unique identifier of the surge session for a user. Required when returned from a 409 Conflict response on previous POST attempt.
paymentMethodId String Optional: The unique identifier of the payment method selected by a user. If set, the trip will be requested using this payment method. If not set, the trip will be requested using the user’s last used payment method.
seatCount String Optional: The number of seats required for uberPOOL. Default and maximum value is 2.
fareId String Optional: The key for the upfront price of an uberPOOL ride. Required if we want to use a previously retrieved price estimate for POOL. If it is missed, we will automatically issue a new upfront price for the ride request.
expenseCode String Optional: An alphanumeric identifier for expense reporting policies. This value will appear in the trip receipt and any configured expense-reporting integrations like Uber For Business or Business Profiles.
expenseMemo String Optional: A free text field to describe the purpose of the trip for expense reporting. This value will appear in the trip receipt and any configured expense-reporting integrations like Uber For Business or Business Profiles.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.requestRideById

The Ride Request endpoint allows a ride to be requested on behalf of an Uber user using place Ids.

Field Type Description
accessToken String The valid access token.
startPlace_id String The beginning or “pickup” place ID. This is the name of an Uber saved place. Only “home” or “work” is acceptable. Either this or startLatitude and startLongitude must be specified.
endPlace_id String The final or destination place ID. This is the name of an Uber saved place. Only “home” or “work” is acceptable. Either this or endLatitude and endLongitude may be specified.
startNickname String Optional: The beginning or “pickup” nickname label.
endNickname String Optional: The final or destination nickname label.
startAddress String Optional: The beginning or “pickup” address.
endAddress String Optional: The final or destination address.
productId String Optional: The unique ID of the product being requested. If none is provided, it will default to the cheapest product for the given location.
surgeConfirmationId String Optional: The unique identifier of the surge session for a user. Required when returned from a 409 Conflict response on previous POST attempt.
paymentMethodId String Optional: The unique identifier of the payment method selected by a user. If set, the trip will be requested using this payment method. If not set, the trip will be requested using the user’s last used payment method.
seatCount String Optional: The number of seats required for uberPOOL. Default and maximum value is 2.
fareId String Optional: The key for the upfront price of an uberPOOL ride. Required if we want to use a previously retrieved price estimate for POOL. If it is missed, we will automatically issue a new upfront price for the ride request.
expenseCode String Optional: An alphanumeric identifier for expense reporting policies. This value will appear in the trip receipt and any configured expense-reporting integrations like Uber For Business or Business Profiles.
expenseMemo String Optional: A free text field to describe the purpose of the trip for expense reporting. This value will appear in the trip receipt and any configured expense-reporting integrations like Uber For Business or Business Profiles.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.updateCurrentRide

The Ride Request endpoint allows updating an ongoing request’s destination.

Field Type Description
accessToken String The valid access token.
endLatitude String The final or destination latitude. Either this or endPlaceId must be specified.
endLongitude String The final or destination longitude. Either this or endPlaceId must be specified.
endAddress String Optional: The final or destination address.
endNickname String Optional: The final or destination nickname label.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.updateCurrentRideById

The Ride Request endpoint allows updating an ongoing request’s destination using place Id.

Field Type Description
accessToken String The valid access token.
endAddress String Optional: The final or destination address.
endNickname String Optional: The final or destination nickname label.
endPlaceId String The final or destination place ID. This is the name of an Uber saved place. Only “home” or “work” is accepted. Either this or endLatitude and endLongitude must be specified.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.cancelCurrentRide

The Ride Request endpoint allows cancellation of the user's current trip.

Field Type Description
accessToken String The valid access token.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.getRideEstimate

The Request Estimate endpoint allows a ride to be estimated given the desired product, start, and end locations.

Field Type Description
accessToken String The valid access token.
productId String Optional: The unique ID of the product being requested. If none is provided, it will default to the cheapest product for the given location.
startLatitude String Optional: The beginning or "pickup" latitude. Either this or startPlaceId must be specified.
startLongitude String Optional: The beginning or "pickup" longitude. Either this or startPlaceId must be specified.
startPlaceId String Optional: The beginning or “pickup” place ID. This is the name of an Uber saved place. Only “home” or “work” is acceptable. Either this or startLatitude and startLongitude must be specified.
endLatitude String Optional: The final or destination latitude. If not included, only the pickup ETA and details of surge pricing will be included.
endLongitude String Optional: The final or destination longitude. If not included, only the pickup ETA and details of surge pricing will be included.
endPlaceId String Optional: The final or destination place ID. This is the name of an Uber saved place. Only “home” or “work” is acceptable. Either this or endLatitude and endLongitude may be specified.
seatCount String Optional: The number of seats required for uberPOOL. Default and maximum value is 2.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.updateRide

The Ride Request endpoint allows updating an ongoing request’s destination using the Ride Request endpoint.

Field Type Description
accessToken String The valid access token.
requestId String Unique identifier representing a Request.
endLatitude String Optional: The final or destination latitude. Either this or endPlaceId must be specified.
endLongitude String Optional: The final or destination latitude. Either this or endPlaceId must be specified.
endAddress String Optional: The final or destination address.
endNickname String Optional: The final or destination nickname label.
endPlaceId String Optional: The final or destination place ID. This is the name of an Uber saved place. Only “home” or “work” is accepted. Either this or endLatitude and end_Longitude must be specified.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.cancelRide

The Ride Request endpoint allows cancellation of an ongoing Request on behalf of a rider.

Field Type Description
accessToken String The valid access token.
requestId String Unique identifier representing a Request.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.getRideMap

The Ride Request endpoint getting a map with a visual representation of a Request.

Field Type Description
accessToken String The valid access token.
requestId String Unique identifier representing a Request.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox

UberRide.getReceipt

The Ride Request endpoint allows getting the receipt information of the completed request.

Field Type Description
accessToken String The valid access token.
requestId String Unique identifier representing a Request.
sandbox Boolean UberAPI Sandbox: 1 to select sandbox
Have a question about this API?Ask the API Provider.
Developers who viewed UberRide also viewed

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication