Skip to main content

HourlySearchRequest

Hourly hire search: a car and driver at the passenger's disposal for hours hours. Unknown fields are rejected.

pickup objectrequired

Pickup location.

latnumberrequired

Latitude, -90 to 90.

Possible values: >= -90 and <= 90

Example: 18.9217
lngnumberrequired

Longitude, -180 to 180.

Possible values: >= -180 and <= 180

Example: 72.8332
addressstringrequired

Full address, at least 3 characters.

Possible values: >= 3 characters

Example: Apollo Bunder, Colaba, Mumbai 400001
namestring | nullnullable

Place name, for example a hotel or station.

Example: The Taj Mahal Palace
citystring | nullnullable

City. Recommended: some providers need it to find the city they serve.

Example: Mumbai
country_codestring | nullnullable

ISO 3166-1 alpha-2, upper case. Recommended: providers limited to one country are skipped when the pickup is elsewhere.

Possible values: >= 2 characters and <= 2 characters

Example: IN
tp_location_idstring | nullnullable

Location id agreed with Pathfndr, when you have one.

Possible values: <= 64 characters

Example: null
pickup_datestringrequired

Pickup date, YYYY-MM-DD, local to the pickup.

Example: 2026-11-27
pickup_timestringrequired

Pickup time, HH:MM (24 h), local to the pickup.

Example: 10:00
adultsinteger

Adults. Adults + children + infants: at most 16.

Possible values: >= 1

Default value: 1
Example: 2
childreninteger

Children.

Possible values: >= 0

Default value: 0
Example: 0
infantsinteger

Infants.

Possible values: >= 0

Default value: 0
Example: 0
luggageinteger | nullnullable

Number of suitcases. Used by providers that price by luggage. Default: one per adult.

Possible values: >= 0 and <= 20

Example: 2
currencystring

Requested currency, ISO 4217 (for example INR, USD, EUR). Every price in the response is in this currency. An unsupported code answers 422 unsupported_currency.

Possible values: >= 3 characters and <= 3 characters

Default value: USD
Example: INR
providersProviderCode[]nullable

Restrict the search to these providers. Default: all providers enabled for your key.

Possible values: Value must match regular expression ^[a-z0-9_]+$

Example: ["provider_a","provider_b"]
metadata object

Free-form. Not used today.

property name*any

Free-form. Not used today.

Example: {}
transfer_typestring

hourly. Required.

Constant value: hourly
Default value: hourly
Example: hourly
hoursintegerrequired

Hours of hire, whole hours. Availability varies by location; a provider that cannot serve the requested hours or location returns no offers and is listed in meta.skipped_providers.

Possible values: >= 1 and <= 24

Example: 4
dropoff object

Where the hire ends. Default: the pickup.

anyOf

A pickup or drop-off location for point-to-point and hourly searches.

latnumberrequired

Latitude, -90 to 90.

Possible values: >= -90 and <= 90

Example: 18.9217
lngnumberrequired

Longitude, -180 to 180.

Possible values: >= -180 and <= 180

Example: 72.8332
addressstringrequired

Full address, at least 3 characters.

Possible values: >= 3 characters

Example: Apollo Bunder, Colaba, Mumbai 400001
namestring | nullnullable

Place name, for example a hotel or station.

Example: The Taj Mahal Palace
citystring | nullnullable

City. Recommended: some providers need it to find the city they serve.

Example: Mumbai
country_codestring | nullnullable

ISO 3166-1 alpha-2, upper case. Recommended: providers limited to one country are skipped when the pickup is elsewhere.

Possible values: >= 2 characters and <= 2 characters

Example: IN
tp_location_idstring | nullnullable

Location id agreed with Pathfndr, when you have one.

Possible values: <= 64 characters

Example: null
HourlySearchRequest
{
  "pickup": {
    "lat": 18.9217,
    "lng": 72.8332,
    "name": "The Taj Mahal Palace",
    "address": "Apollo Bunder, Colaba, Mumbai 400001",
    "city": "Mumbai",
    "country_code": "IN"
  },
  "pickup_date": "2026-11-27",
  "pickup_time": "10:00",
  "adults": 2,
  "children": 0,
  "infants": 0,
  "luggage": 2,
  "currency": "INR",
  "providers": [
    "provider_a",
    "provider_b"
  ],
  "metadata": {},
  "transfer_type": "hourly",
  "hours": 4,
  "dropoff": {
    "lat": 18.9217,
    "lng": 72.8332,
    "name": "The Taj Mahal Palace",
    "address": "Apollo Bunder, Colaba, Mumbai 400001",
    "city": "Mumbai",
    "country_code": "IN"
  }
}