Price filter

GET https://quis.de/api/v1/price_filter?api_key=<YOUR-API-KEY>&address=<YOUR-ADDRESS>&type_of_demand=<rent|buy> HTTP/2

The price filter endpoint provides up-to-date data about the prices in a specific region. The data's area is limited to the postal code or the city, depending on which is smaller. You can cache this data for the region, as it would not differ for neighboured building blocks.

Limitations

For performance reasons, the number of exposés included in the output and calculation is limited to 3000. The API call returns at maximum the 3000 exposés, closest to the address or coordinate, matching the parameters and the calculation based on them.

Parameters

Either the address or coordinate parameter is required. If both are provided, the address will be used.

parameterdescription
api_keyRequired Your API key, find more information in the authentication section
addressThe address will be used to find the building block. For more precise results, use addresses in the following format: street house_number, postal_code city
coordinateThe coordinate will be used to find the building block.
type_of_demandRequired The type of demand must be specified. Accepted values are rent and buy
rooms[min]The minimal room number an object should have. Default: 1
rooms[max]The maximal room number an object should have. Default: 7
living_space[min]The minimal living space an object should have. Default: 15
living_space[max]The maximal living space an object should have. Default: 400
price[min]The minimal price per square meter an object should have. For type_of_demand=rent the internal minimum is 3 and for type_of_demand=buy it is 300. Default: 3
price[max]The maximal price per square meter an object should have. For type_of_demand=rent the internal maximum is 40 and for type_of_demand=buy it is 20000. Default: 20000
building_year[min]The minimal building year an object should have. Default: 1800
building_year[max]The maximal building year an object should have. Default: CURRENT_YEAR
radiusRadius around coordinate in meter. Uses the geometry of the postal code region if no value is provided. Default: POSTAL_CODE

Possible values:
500 1000 2000 5000 10000
object_typeType of property as comma separated list, e.g. 15,1, includes Loft and all houses. Default: ALL

Possible values:
7 appartments
- 16 'Maisonette'
- 14 'Penthouse'
- 15 'Loft'
- 8 'Etagenwohnung'
- 11 'Erdgeschoss'
- 10 'Dachgeschoss'
- 9 'Apartment'
- 18 'Sonstige Wohnungen'

0 houses
- 2 'Einfamilienhaus'
- 3 'Doppelhaushälfte'
- 5 'Reihenhaus'
- 17 'Sonstige Häuser'
furnishedIf the object should be furnished. Default: false
subsidized_housing_permitIf the object should be publicly subsidized. The potential tenant requires such a permit. Default: false
first_time_useOnly show objects marked for first-time use after build. Default: false
start_dateEarliest date the advertisements were published. Default: 2018-02-01
end_dateLatest date the advertisements were published. Default: YESTERDAY

Example

{
  "api_key": "YOUR API KEY",
  "address": "Gasstraße, Hamburg",
  "type_of_demand": "rent",
  "rooms": {
    "max": 4
  },
  "price": {
    "min": 10.5
  },
  "radius": 500,
  "object_type": "15,1",
  "furnished": true,
  "subsidized_housing_permit": true,
  "first_time_use": true,
  "start_date": "2019-01-01",
  "end_date": "2019-03-31"
}

This example configuration will need to generate an URL like:

GET https://quis.de/api/v1/price_filter?api_key=<YOUR-API-KEY>&address=Gasstraße,Hamburg&type_of_demand=rent&rooms[max]=4&price[min]=10.5&radius=500&object_type=15,1&furnished=true&subsidized_housing_permit=true&first_time_use=true&start_date=2019-01-01&end_date=2019-03-31 HTTP/2

Example

The provided data has random values to give you a feeling about the format you can expect.

GET https://quis.de/api/v1/price_filter?api_key=<YOUR-API-KEY>&address=gasstraße,hamburg&type_of_demand=rent HTTP/2
{
  "count": 2500,
  "median_duration": 11.2,
  "median": 17.62,
  "average": 11.67,
  "minimum_price": 2.55,
  "maximum_price": 52.0,
  "interval": {
    "10": 0.34,
    "90": 24.67
  },
  "exposes": [
    {
      "url_id": 9407457,
      "source": "immonet.de",
      "start_date": "2018-05-24",
      "end_date": "2018-05-31",
      "duration": "7 Tage",
      "offer_type": "Mietwohnung",
      "street": "Bahrenfelder Chaussee",
      "postcode": "22761",
      "city": "Hamburg",
      "cold_rent": 540.0,
      "price_square_meter": 10.8,
      "additional_cost": 75.0,
      "floor": 2.0,
      "rooms": 2.0,
      "living_area": 50.0,
      "usable_area": null,
      "land_area": null,
      "construction_year": 1934,
      "vacant_from": "2018-07-01",
      "object_condition": "Altbau",
      "object_type": "Etagenwohnung",
      "first_occupancy": null,
      "kitchen": true,
      "balcony_terrace": null,
      "barrier_free": null,
      "lift": null,
      "parking_space": null,
      "furnished": null,
      "underfloor_heating": null,
      "subsidized_housing_permit": null
    },
    {
      "url_id": 10287830,
      "source": "immobilienscout24.de",
      "start_date": "2018-07-17",
      "end_date": "2018-08-06",
      "duration": "21 Tage",
      "offer_type": "Mietwohnung",
      "street": "Bahrenfelder Steindamm",
      "postcode": "22761",
      "city": "Hamburg",
      "cold_rent": 728.0,
      "price_square_meter": 11.03,
      "additional_cost": 185.0,
      "floor": 5.0,
      "rooms": 2.0,
      "living_area": 66.0,
      "usable_area": null,
      "land_area": null,
      "construction_year": 1902,
      "vacant_from": null,
      "object_condition": "Gepflegt",
      "object_type": "Dachgeschoss",
      "first_occupancy": null,
      "kitchen": true,
      "balcony_terrace": true,
      "barrier_free": null,
      "lift": true,
      "parking_space": null,
      "furnished": null,
      "underfloor_heating": null,
      "subsidized_housing_permit": null
    },
    ...
  ],
  "meta": {
    "url": "https://quis.de/geo/53.56238135,9.91097785903008",
    "version": "1.10.1"
  }
}