Apartments

This endpoint is not generally available for questions please contact sales .
To simplify the parameters and to support a broader variety of packages, this endpoint accepts both GET and POST requests.
GET https://quis.de/api/v1/vps/apartments?api_key=<YOUR-API-KEY>&address=<YOUR-ADDRESS>&living_space=<LIVING-SPACE>&building_year=<BUILDING-YEAR>&condition=<CONDITION>&furnishing=<FURNISHING> HTTP/2

The apartment endpoint provides a first valuation for an apartment with specific characteristics.

Parameters

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

parametertypedescription
api_keystringRequired Your API key, find more information in the authentication section
addressstringThe 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
coordinatestringThe coordinate will be used to find the building block.
Format: latitude,longitude
Example: 53.56132168856504,9.91211843516794
living_spacefloatRequired The living space of the property. It is used to calculate the total valuation.
building_yearintegerThe building year of the property.
conditionstringThe condition of the property.
Available values: dilapidated, bad, moderate, good, very good
furnishingstringThe furnishing of the property.
Available values: very simple, simple, good, upscale, very upscale

Example

{
  "api_key": "YOUR API KEY",
  "address": "Gasstraße, Hamburg",
  "living_space": 52.12,
  "building_year": 1980,
  "condition": "good",
  "furnishing": "good"
}

This example configuration will need to generate an URL like:

GET https://quis.de/api/v1/vps/apartments?api_key=<YOUR-API-KEY>&address=Gasstraße,Hamburg&living_space=52.12&building_year=1980&condition=good&furnishing=good HTTP/2

Response values

valuetypedescription
valuationfloatThe predicted value of the apartment
confidenceintegerThe confidence of the valuation.
Values are ranging from 1 - not confident to 5 - very confident.

Example

The provided example has random values and incomplete series, showing the expected format.
GET https://quis.de/api/v1/vps/apartments?api_key=<YOUR-API-KEY>&address=Gasstraße,Hamburg&living_space=52.12&building_year=1980&condition=good&furnishing=good HTTP/2
{
  "valuation": 123456.78,
  "confidence": 3,
  "meta": {
    "url": "https://quis.de/geo/53.56238135,9.91097785903008",
    "version": "1.10.1"
  }
}