Create estimation

Obtain prices, product IDs, and all the information for products that are available at the origin point.

❗️

Important

You must call this endpoint before creating a Journey. The response provides the product.id
that should be passed to the journey creation endpoint.

For reserved journeys, pass the same start_at used here to the journey creation request
to guarantee consistent product availability and pricing.

We recommend estimating no more than 5 minutes before creating the journey.

Response

The response contains an array of available products, each with:

  • product.id — pass as product_id when creating a journey
  • Estimated price and currency
  • ETA (estimated time of arrival)
  • Vehicle category information

Hub Information

When the origin is within a large venue (airport, train station, etc.), each estimation object may include a hub field containing:

  • Hub metadata (uid, title, location_id)
  • A list of meeting points — designated pick-up locations with coordinates, images, and localized instructions

The hub field is resolved on a best-effort basis in parallel with pricing. It may be null if hub resolution does not complete in time or no hub exists at the origin.

📘

Using Hub Data

When a hub is present, present the meeting points to the user for selection and include the chosen one in the journey creation request via the meeting_point field in the origin stop.
Alternatively, use GET /api/v4/hub to look up hub data independently.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Estimate request

Request an estimate before creating a journey.

The estimation response provides the product.id value that must be passed to the journey
creation endpoint. For reserved journeys, also pass the same start_at used here to the
journey creation request to ensure consistent pricing and availability.

We recommend requesting a new estimate no more than 5 minutes before creating a journey.

string
required
^[a-f0-9]{32}$

User to which the estimates would be scoped.

string | null
^([0-9]+(-[0-9]+)+)\s+([0-9]+(:[0-9]+)+)$

When using startType RESERVED this attribute defines the date and time of the reservation. Accepted format must be YYYY-MM-DD HH:MM:SS. It should be in the local time of the pick up location.

string
enum
required

Specifies whether the journey should start right now or it should be a reservation later in time. Note that if the value is RESERVED startAt attribute has to be a valid date. If ASAP startAt will be ignored.

Allowed:
stops
array of objects
required
length ≥ 2
Defaults to []

The actual coordinates of the address. Required two floats per location latitude and longitude.

stops*
loc
array of numbers
length between 2 and 2
loc
loc
array of numbers
length between 2 and 2
loc
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Callback
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/text