Get offers

Download

Gets offers matching specific query parameters

Request

regionID
integer
required

Region ID for which offers are returned. This includes offers from all subregions of this regionID. See the 'Introduction' Section in the documentation.

timeRangeStart
integer
required

Timestamp (ms since UNIX epoch) from when offers are considered (inclusive). This includes offers that start after this time (no partitioning of offers).

timeRangeEnd
integer
required

Timestamp (ms since UNIX epoch) until when offers are considered (inclusive). This includes offers that end before this time (no partitioning of offers).

numberDays
integer
required

The number of full days (24h) the car is available within the rangeStart and rangeEnd

sortOrder
string
required

Allowed Values:

price-ascprice-desc

The order in which offers are returned. When two offers have the same price, the one with the lexicographical smaller ID is returned first (for both sort orders).

page
integer
required

The page number from pagination

pageSize
integer
required

The number of offers per page

priceRangeWidth
integer
required

The width of the price range blocks in cents. See 'priceRanges' in the response body more for information.

minFreeKilometerWidth
integer
required

The width of the min free kilometer in km. See 'freeKilometerRange' in the response body more for information.

minNumberSeats
integer

How many seats the returned cars each have

minPrice
number

Minimum (inclusive) price the offers have in cent

maxPrice
number

Maximum (exclusive) price the offers have in cent

carType
string

Allowed Values:

smallsportsluxuryfamily

The car type.

onlyVollkasko
boolean

Whether only offers with vollkasko are returned

minFreeKilometer
integer

Minimum number of kilometers that the offer includes for free (min. inclusive)

Response

The IDs and data of the offers matching the query parameters. For aggregation results, see the 'Filter and Aggregations'-section in the documentation.

ID
string
required

The unique identifier of the offer

data
string
required

Additional data of the offer, that is not used for filtering. For simplicity, this is just a base64 encoded 256 Byte array

start
integer
required

The start of the price range in cent

end
integer
required

The end of the price range in cent

count
integer
required

The number of offers in this price range

small
integer
required

The number of offers with the car type small

sports
integer
required

The number of offers with the car type sports

luxury
integer
required

The number of offers with the car type luxury

family
integer
required

The number of offers with the car type family

numberSeats
integer
required

The number of seats the cars have

count
integer
required

The number of offers with the given number of seats

start
integer
required

The start of the free kilometer range

end
integer
required

The end of the free kilometer range

count
integer
required

The number of offers in this free kilometer range

trueCount
integer
required

The number of offers with vollkasko

falseCount
integer
required

The number of offers without Vollkasko

Response Sample