Car Rental Geosearch

GET

Car Rental Geosearch

With this API you can find out the price and type of car, for all car rental providers, in a specified geographical location.

You can quickly see the locations of car providers near a given point, and what cars are available to rent, and at what prices. This API is based on our car pricing service that gets live availability from car providers, and is used to power a variety of airline and travel agency websites.

Results are validated from car providers, and thus response times may take up to 10 seconds (response times are typically about 5s), and the number of concurrent calls is throttled per user to avoid flooding our provider's systems. However, this means the final result is guaranteed to be live and accurate.

The configuration of this API allows search for car rentals in the rental location where the car is picked up (at the start of the rental), is the same as the one where it will be dropped off.

Resource URL

https://api.sandbox.amadeus.com/v1.2 /cars/search-circle

Query Parameters


Name Values Description
apikey
(required)

API Key provided for your account, to identify you for API access. Make sure to keep this API key secret.

latitude
(required)

Latitude of the center of the search.

longitude
(required)

Longitude of the center of the search.

radius
(required)

Radius around the center to look for hotels in kilometers (km).

pick_up
(required)

Date on which the car rental will be collected from the car rental location. If no time is provided, a default value of 09:00 is used. Past availability is not displayed, future availability becomes less useful from about 6 months from the current date.

drop_off
(required)

Date at which the car rental will end and the car will be returned to the rental location. If no time is provided, a default value of 17:00 is used.

lang

The preferred language of the content related to each car rental. Content will be returned in this language if available.

currency

The preferred currency to use when displaying prices and rates related to the car rental.

provider

2 character car rental provider code. You may provide this parameter more than once.

rate_class

Allows to request specific rate types.

rate_plan

Qualifies the rate depending on the pickup date and the rental duration.

rate_filter

Defines the types of rates to be returned in the output

vehicle

Specifies the type of vehicle to be rented. If selected, the results set will include only vehicles that match these type descriptions. The enumerations above correspond to ACRISS Pseudo Codes, and you may also provide an ACRISS pseudo code directly. If specifying a vehicle-specific ACRISS code, you may provide this parameter up to 3 times.


Request Body

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

 

Response format - Cars Radius/Circle Search

The response is returned in JSON with the following elements:

Element Meaning Multiplicity
Root object
results The array of search result objects, sorted by price. The length of the array will correspond to the number_of_results parameter used in the input. 1..99
Result object
provider A company object detailing the car rental company offering this rental. 1
location This car rental company's approximate geolocation as a location object. The exact quality of this parameter depends on the provider but it's usually quite accurate. 0..1
airport This car rental company's airport IATA code, if it is located at an airport. 0..1
cars An array of vehicle objects giving further details about each of the vehicles offered by this car rental provider. 0..n
Company object
company_code The Amadeus 2-character company code of this car rental provider. 1
company_name The long name of this car rental provider corresponding to the above code. 1
Location object
latitude The north-south location of this car rental location, in decimal degrees, between -90 and 90. 1
longitude The east-west location of this car rental location, in decimal degrees, between -180 and 180. 1
Vehicle object
vehicle_info Vehicle info object containing more information about the type of vehicle on offer. 1
rates An array of rate objects to let you know what rates will be applied during the duration of the car rental requested. These rates are generally not inclusive of tax and are used by the car rental company to compute the total cost at the end of the rental period. 0..n
estimated_total The estimated total cost of the rental given the rental period and location provided, including all mandatory taxes and charges, and using a default set of rental options and restrictions defined by the car company, as a Price object. 0..1
image An image objects to give an indication of what to expect when renting this vehicle. 0..1
Vehicle info object
acriss_code The 4 letter ACRISS code that defines the properties of vehicle being rented. 1
category The decoded ACRISS vehicle category (For example: Economy, Luxury, Standard). 1
type The decoded ACRISS vehicle type, to let you know what kind of vehicle this is (For example: Van, SUV, Pickup). 0..1
transmission The decoded ACRISS transmission type, to let you know if this vehicle is Automatic or Manual Transmission (stick-shift). 0..1
air_conditioning The decoded ACRISS air_conditioning information, to let you know if this vehicle has air conditioning, as a true/false boolean. 0..1
fuel The decoded ACRISS fuel type, to let you know if this vehicle is hybrid, electric, etc. 0..1
Rate object
type The type or applicability period of rate being applied. For example: DAILY, WEEKLY, WEEKEND. 1
price The overall cost of the rate being applied as a price object. 1
Price object
amount The monetary amount of this price in the given currency. For example: 219.99. 1
currency The ISO 4217 currency code in which this amount applies. For example: USD. 1
Image object
width The pixel width of the image at the provided URL. 1
height The pixel height of the image at the provided URL. 1
url The URL of the car image of this given category and size, for display. 1

 

 

Example - Circle/Radius search

Here's a simple search example. Just copy the following URLs in your browser. Don't forget to adjust the check-in and check-out dates as necessary, and use your own API key.

Limit search to Hertz car rental (provider ZE) and Dollar car rental (provider ZR) within 50km of Oakland, prices in Euro:

http://api.sandbox.amadeus.com/v1.2/cars/search-circle?pick_up=2015-11-22&drop_off=2015-11-23&latitude=37.721278&longitude=-122.220722&radius=25&providers=ZR,ZE¤cy=EUR&apikey=<your API key>

Response

{
	"results": [
		{
			"provider": {
				"company_code": "ZR",
				"company_name": "DOLLAR"
			},
			"location": {
				"latitude": 37.80676,
				"longitude": -122.41365
			},
			"address": {
				"line1": "2500 MASON STREET",
				"city": "SAN FRANCISCO",
				"region": "CA",
				"country": "US"
			},
			"cars": [
				{
					"vehicle_info": {
						"acriss_code": "XXAR",
						"transmission": "Automatic",
						"fuel": "Unspecified",
						"air_conditioning": true,
						"category": "Special",
						"type": "Special"
					},
					"rates": [
						{
							"type": "DAILY",
							"price": {
								"amount": "51.11",
								"currency": "EUR"
							}
						}, {
							"type": "DAILY",
							"price": {
								"amount": "55.00",
								"currency": "USD"
							}
						}
					],
					"estimated_total": {
						"amount": "113.81",
						"currency": "EUR"
					}
				}
			]
		}, {
			"provider": {
				"company_code": "ZE",
				"company_name": "HERTZ"
			},
			"location": {
				"latitude": 37.71667,
				"longitude": -122.2167
			},
			"airport": "OAK",
			"address": {
				"line1": " 7600 EARHART ROAD, SUITE 1",
				"city": "OAKLAND AP",
				"region": "CA",
				"postal_code": "94621",
				"country": "US"
			},
			"cars": [
				{
					"vehicle_info": {
						"acriss_code": "ECAR",
						"transmission": "Automatic",
						"fuel": "Unspecified",
						"air_conditioning": true,
						"category": "Economy",
						"type": "2/4 Door"
					},
					"rates": [
						{
							"type": "WEEKEND",
							"price": {
								"amount": "41.63",
								"currency": "EUR"
							}
						}, {
							"type": "WEEKEND",
							"price": {
								"amount": "44.80",
								"currency": "USD"
							}
						}
					],
					"estimated_total": {
						"amount": "83.26",
						"currency": "EUR"
					}
				}, {
					"vehicle_info": {
						"acriss_code": "PCAR",
						"transmission": "Automatic",
						"fuel": "Unspecified",
						"air_conditioning": true,
						"category": "Premium",
						"type": "2/4 Door"
					},
					"rates": [
						{
							"type": "WEEKEND",
							"price": {
								"amount": "57.24",
								"currency": "EUR"
							}
						}, {
							"type": "WEEKEND",
							"price": {
								"amount": "61.60",
								"currency": "USD"
							}
						}
					],
					"estimated_total": {
						"amount": "114.48",
						"currency": "EUR"
					}
				}, {
					"vehicle_info": {
						"acriss_code": "LCAR",
						"transmission": "Automatic",
						"fuel": "Unspecified",
						"air_conditioning": true,
						"category": "Luxury",
						"type": "2/4 Door"
					},
					"rates": [
						{
							"type": "WEEKEND",
							"price": {
								"amount": "91.06",
								"currency": "EUR"
							}
						}, {
							"type": "WEEKEND",
							"price": {
								"amount": "98.00",
								"currency": "USD"
							}
						}
					],
					"estimated_total": {
						"amount": "182.12",
						"currency": "EUR"
					}
				}
			]
		}
	]
}