GeoMap logo
API docs by Redocly

GeoMap Public API - KPI (1.3.0)

E-mail: kontakt@geomap.immo

Introduction

Documentation of the GeoMap API.

Changelog

API version 1.3.0

  • constructionStatus added to Single and Collection request
  • salesStatus added to Single and Collection request

API version 1.2.0

  • regionIds added to Single and Collection request

API version 1.1.0

  • objectSubtypes added to Single and Collection request

API version 1.0.0

  • first release

KPI

Real estate key performance indicators

Single

Provides a single KPI of an analysis of offers in Austria, Germany and Switzerland by

  • location and surrounding area
  • postcode area(s)
  • administrative region(s)

Various statistical measures and truncation of outliers are available for analysis.

The offers can optionally be filtered by e.g. date, category, price and so on.

Authorizations:
BearerAuth
Request Body schema: application/json
One of
required
object

Geolocation defined by latitude and longitude

radiusInKm
number <double> ( 0 .. 50 ]
Default: 10

Radius in kilometer around the coordinate

airConditioningVentilation
boolean

Property is equipped with air conditioning and / or ventilation

balconyTerrace
boolean

Balcony and / or terrace available

barrierFree
boolean

Property is barrier-free

bathroomWithWindow
boolean

Bathroom with window

builtInKitchen
boolean

Built-in kitchen

cellar
boolean

Building has a cellar

constructionStatus
Array of strings
Items Enum: "Abgebrochen" "FertiggestelltBestand" "Idee" "ImBauInSanierung" "InKlaerung" "InPlanung" "Unbekannt"

Construction status of the property

  • Abgebrochen - Canceled
  • FertiggestelltBestand - Finished / existing
  • Idee - Idea
  • ImBauInSanierung - In Construction
  • InKlaerung - In clarification
  • InPlanung - Planned
  • Unbekannt - Unknown
object

Range for year of construction defined by from or to or both

developments
Array of strings
Items Enum: "erschlossen" "teilerschlossen" "unerschlossen"

State of property development

divisible
boolean

Useable space is divisible

elevator
boolean

Property is equipped with an elevator

object

Range of energy consumption in kWh/sqm*a defined by from or to or both

energyEfficiencyStandards
Array of strings
Items Enum: "KfwEffizienzhausDenkmal" "KfwEffizienzhaus115" "KfwEffizienzhaus100" "KfwEffizienzhaus85" "KfwEffizienzhaus70" "KfwEffizienzhaus60" "KfwEffizienzhaus55" "KfwEffizienzhaus40" "KfwEffizienzhaus40Plus" "Passivhaus" "Nullenergiehaus" "Plusenergiehaus"

Energy efficiency standard according to Germany’s Reconstruction Loan Corporation (KfW)

energyRatings
Array of strings (energyRatingLabel)
Items Enum: "A3Plus" "A2Plus" "APlus" "A" "B" "C" "D" "E" "F" "G" "H"

Energy efficiency rating

energySources
Array of strings
Items Enum: "Erdgas" "Erdwaerme" "Fernwaerme" "Fluessiggas" "Gas" "Holz" "Kohle" "Luftwaerme" "Nahwaerme" "Oel" "Pellets" "Solar" "Strom" "Wasserwaerme" "Alternativ"

Primary energy source for heating

fireplace
boolean

Property has a fireplace

object

Date range at which the offers were first seen online defined by from or to or both

firstTimeUse
boolean

First time use after refurbishment or new construction

freeOfCommission
boolean

Buying / renting is commission-free

furnished
boolean

Property is furnished

garden
boolean

A garden belongs to the property

guestToilet
boolean

Property is equipped with a guest toilet

heatingTypes
Array of strings
Items Enum: "Blockheizkraftwerk" "Etagenheizung" "Fernheizung" "Fussbodenheizung" "Kachelofen" "Kamin" "Nachtspeicher" "Ofenheizung" "Solarheizung" "Waermepumpe" "Zentralheizung"

Primary heating system

leased
boolean

Property is currently leased

modelHouseAdvertisement
boolean

Property is a model / show house or advertisement

object

Range for number of rooms defined by from or to or both

objectCategories
Array of strings
Items Enum: "Gewerbe" "Wohnen"

Object category of the offers (residential, commercial)

objectClasses
Array of strings
Items Enum: "BüroPraxis" "Einzelhandel" "Ferienobjekt" "Gastronomie" "Gewerbeeinheit" "Grundstueck" "HalleLagerProduktion" "Haus" "Hotel" "LandForst" "Microapartements" "Parkhaus" "PflegeAlter" "Sonstige" "StellplatzGarage" "Studenten" "Wohnung"

Object class of the offers (houses, ...)

objectTypes
Array of strings
Items Enum: "Altersheim" "Bauernhof" "Cafe" "Coworking" "Dachgeschosswohnung" "EinZweiFamilienhaus" "Erdgeschosswohnung" "Etagenwohnung" "Gaststaette" "Ladenlokal" "LoftStudio" "Maisonettenwohnung" "Mehrfamilienhaus" "Pension" "Penthouse" "Pflegeheim" "ReitanlageGestuet" "Restaurant" "Sonstige" "SonstigeWohnungen" "Terrassenhaus" "Terrassenwohnung" "WarenKaufhaus" "Werkstatt"

Object type of the offers (multifamilyhouses, ...)

objectSubtypes
Array of strings
Items Enum: "Einfamilienhaus" "Doppelhaushaelfte" "Zweifamilienhaus" "Reihenhaus" "ReiheneckEndhaus" "Reihenmittelhaus"

Object subtype of the offers (e.g. rowhouse as a subtype of object type EinZweiFamilienhaus, ...)

offerTypes
Array of strings
Items Enum: "Kauf" "Miete"

Type of the offers (purchase or rent)

object

Date range at which the offers were online available defined by from or to or both

parkingSpace
boolean

A parking lot belongs to the property

preservationOrder
boolean

Property is under a preservation order

priceChange
boolean

Price has changed since first publication

priceChangeDirection
string
Enum: "HOCH" "RUNTER"

Direction of price changes HOCH means higher price, RUNTER means property becomes cheaper. Only applicable if priceChange == true

priceChangeSince
string <date>

Price changes since the given date. Only applicable if priceChange == true. If no date is provided the current date will be assumed

object

Range of price per square meter in local currency defined by from or to or both

object

Range of price in local currency defined by from or to or both

object

Range of property space in m² defined by from or to or both

object

Range of reconstruction year defined by from or to or both

refurbished
boolean

Property is refurbished

salesStatus
Array of strings
Items Enum: "ImVerkauf" "Unbekannt" "Verkauft" "VorVerkauf"

Status of sales progress

  • ImVerkauf - On Sale
  • Unbekannt - Unknown
  • Verkauft - Sold
  • VorVerkauf - Not yet offered
searchString
string

Search for the given text within the offer descriptions, title, street name, city name, vendor name and vendor company name. Several search words are combined using OR

underfloorHeating
boolean

Underfloor heating is available

object

Range of useable space in m² defined by from or to or both

vendorIsCommercial
boolean

Vendor is an estate agent

object

Range of yield / cap rate in percent defined by from or to or both

analyzedField
string
Default: "PREISPROQM"
Enum: "NUTZFLAECHE" "PREIS" "PREISPROQM" "RENDITE" "TAGEONLINE"

Property attribute to be analyzed

cutOutlier
string
Default: "GEOMAP"
Enum: "GEOMAP" "KEINE" "PERZENTILE"

Method for truncating outliers within the values of analyzedField before the calculation of returnValue

  • GEOMAP - default method, a combination of interquartile range and 0.05 (5%) percentiles and at least 5 items
  • KEINE - no truncation
  • PERZENTILE - cuts the lower and upper outlierPercentile percentile (inclusive). outlierPercentile must be set
outlierPercentile
number <float> decimal places <= 1 ( 0 .. 50 )
Default: 5

Value to calculate the percentile range e.g. value 3.5 means a percentile range from 3.5% to 96.5%. Must be specified together with cutOutlier - PERZENTILE

returnValue
string
Default: "MITTELWERT"
Enum: "MAXIMUM" "MEDIAN" "MINIMUM" "MITTELWERT" "PERZENTIL"

Type of statistic to return. The calculation partially uses non-deterministic algorithm so that the results may slightly vary.

  • MAXIMUM - largest value
  • MEDIAN - value separating the higher half from the lower half
  • MINIMUM - smallest value
  • MITTELWERT - arithmetic average
  • PERZENTIL - percentile score. The 25th percentile is also known as the first quartile (Q1) etc.
returnValuePercentile
number <float> decimal places <= 1 ( 0 .. 100 )

Defines the percentile which is calculated for the returnValue. E.g. value 50 is equivalent to the median. Must be specified together with returnValue - PERZENTIL

Responses

Request samples

Content type
application/json
Example
{
  • "coordinate": {
    },
  • "radiusInKm": 1.5,
  • "airConditioningVentilation": true,
  • "balconyTerrace": true,
  • "barrierFree": true,
  • "bathroomWithWindow": true,
  • "builtInKitchen": true,
  • "cellar": true,
  • "constructionStatus": [
    ],
  • "constructionYearRange": {
    },
  • "developments": [
    ],
  • "divisible": true,
  • "elevator": true,
  • "energyConsumptionRange": {
    },
  • "energyEfficiencyStandards": [
    ],
  • "energyRatings": [
    ],
  • "energySources": [
    ],
  • "fireplace": true,
  • "firstSeenDateRange": {
    },
  • "firstTimeUse": true,
  • "freeOfCommission": true,
  • "furnished": true,
  • "garden": true,
  • "guestToilet": true,
  • "heatingTypes": [
    ],
  • "leased": true,
  • "modelHouseAdvertisement": true,
  • "numberOfRoomsRange": {
    },
  • "objectCategories": [
    ],
  • "objectClasses": [
    ],
  • "objectTypes": [
    ],
  • "objectSubtypes": [
    ],
  • "offerTypes": [
    ],
  • "onlineDateRange": {
    },
  • "parkingSpace": true,
  • "preservationOrder": true,
  • "priceChange": true,
  • "priceChangeDirection": "HOCH",
  • "priceChangeSince": "2019-08-24",
  • "pricePerSqmRange": {
    },
  • "priceRange": {
    },
  • "propertySpaceRange": {
    },
  • "reconstructionYearRange": {
    },
  • "refurbished": true,
  • "salesStatus": [
    ],
  • "searchString": "string",
  • "underfloorHeating": true,
  • "usableSpaceRange": {
    },
  • "vendorIsCommercial": true,
  • "yieldRange": {
    },
  • "analyzedField": "NUTZFLAECHE",
  • "cutOutlier": "GEOMAP",
  • "outlierPercentile": 5,
  • "returnValue": "MAXIMUM",
  • "returnValuePercentile": 99
}

Response samples

Content type
application/json
{
  • "count": 43,
  • "value": 12.34
}

Collection

Provides a collection of KPI of an analysis of offers in Austria, Germany and Switzerland by

  • location and surrounding area
  • postcode area(s)
  • administrative region(s)

The collection includes the statistical measures minimum, maximum, arithmetic average, median, first and third quartile. The calculation partially uses non-deterministic algorithm so that the results may slightly vary. It is possible to cut off outliers for the analysis.

The offers can optionally be filtered by e.g. date, category, price and so on.

Authorizations:
BearerAuth
Request Body schema: application/json
One of
required
object

Geolocation defined by latitude and longitude

radiusInKm
number <double> ( 0 .. 50 ]
Default: 10

Radius in kilometer around the coordinate

airConditioningVentilation
boolean

Property is equipped with air conditioning and / or ventilation

balconyTerrace
boolean

Balcony and / or terrace available

barrierFree
boolean

Property is barrier-free

bathroomWithWindow
boolean

Bathroom with window

builtInKitchen
boolean

Built-in kitchen

cellar
boolean

Building has a cellar

constructionStatus
Array of strings
Items Enum: "Abgebrochen" "FertiggestelltBestand" "Idee" "ImBauInSanierung" "InKlaerung" "InPlanung" "Unbekannt"

Construction status of the property

  • Abgebrochen - Canceled
  • FertiggestelltBestand - Finished / existing
  • Idee - Idea
  • ImBauInSanierung - In Construction
  • InKlaerung - In clarification
  • InPlanung - Planned
  • Unbekannt - Unknown
object

Range for year of construction defined by from or to or both

developments
Array of strings
Items Enum: "erschlossen" "teilerschlossen" "unerschlossen"

State of property development

divisible
boolean

Useable space is divisible

elevator
boolean

Property is equipped with an elevator

object

Range of energy consumption in kWh/sqm*a defined by from or to or both

energyEfficiencyStandards
Array of strings
Items Enum: "KfwEffizienzhausDenkmal" "KfwEffizienzhaus115" "KfwEffizienzhaus100" "KfwEffizienzhaus85" "KfwEffizienzhaus70" "KfwEffizienzhaus60" "KfwEffizienzhaus55" "KfwEffizienzhaus40" "KfwEffizienzhaus40Plus" "Passivhaus" "Nullenergiehaus" "Plusenergiehaus"

Energy efficiency standard according to Germany’s Reconstruction Loan Corporation (KfW)

energyRatings
Array of strings (energyRatingLabel)
Items Enum: "A3Plus" "A2Plus" "APlus" "A" "B" "C" "D" "E" "F" "G" "H"

Energy efficiency rating

energySources
Array of strings
Items Enum: "Erdgas" "Erdwaerme" "Fernwaerme" "Fluessiggas" "Gas" "Holz" "Kohle" "Luftwaerme" "Nahwaerme" "Oel" "Pellets" "Solar" "Strom" "Wasserwaerme" "Alternativ"

Primary energy source for heating

fireplace
boolean

Property has a fireplace

object

Date range at which the offers were first seen online defined by from or to or both

firstTimeUse
boolean

First time use after refurbishment or new construction

freeOfCommission
boolean

Buying / renting is commission-free

furnished
boolean

Property is furnished

garden
boolean

A garden belongs to the property

guestToilet
boolean

Property is equipped with a guest toilet

heatingTypes
Array of strings
Items Enum: "Blockheizkraftwerk" "Etagenheizung" "Fernheizung" "Fussbodenheizung" "Kachelofen" "Kamin" "Nachtspeicher" "Ofenheizung" "Solarheizung" "Waermepumpe" "Zentralheizung"

Primary heating system

leased
boolean

Property is currently leased

modelHouseAdvertisement
boolean

Property is a model / show house or advertisement

object

Range for number of rooms defined by from or to or both

objectCategories
Array of strings
Items Enum: "Gewerbe" "Wohnen"

Object category of the offers (residential, commercial)

objectClasses
Array of strings
Items Enum: "BüroPraxis" "Einzelhandel" "Ferienobjekt" "Gastronomie" "Gewerbeeinheit" "Grundstueck" "HalleLagerProduktion" "Haus" "Hotel" "LandForst" "Microapartements" "Parkhaus" "PflegeAlter" "Sonstige" "StellplatzGarage" "Studenten" "Wohnung"

Object class of the offers (houses, ...)

objectTypes
Array of strings
Items Enum: "Altersheim" "Bauernhof" "Cafe" "Coworking" "Dachgeschosswohnung" "EinZweiFamilienhaus" "Erdgeschosswohnung" "Etagenwohnung" "Gaststaette" "Ladenlokal" "LoftStudio" "Maisonettenwohnung" "Mehrfamilienhaus" "Pension" "Penthouse" "Pflegeheim" "ReitanlageGestuet" "Restaurant" "Sonstige" "SonstigeWohnungen" "Terrassenhaus" "Terrassenwohnung" "WarenKaufhaus" "Werkstatt"

Object type of the offers (multifamilyhouses, ...)

objectSubtypes
Array of strings
Items Enum: "Einfamilienhaus" "Doppelhaushaelfte" "Zweifamilienhaus" "Reihenhaus" "ReiheneckEndhaus" "Reihenmittelhaus"

Object subtype of the offers (e.g. rowhouse as a subtype of object type EinZweiFamilienhaus, ...)

offerTypes
Array of strings
Items Enum: "Kauf" "Miete"

Type of the offers (purchase or rent)

object

Date range at which the offers were online available defined by from or to or both

parkingSpace
boolean

A parking lot belongs to the property

preservationOrder
boolean

Property is under a preservation order

priceChange
boolean

Price has changed since first publication

priceChangeDirection
string
Enum: "HOCH" "RUNTER"

Direction of price changes HOCH means higher price, RUNTER means property becomes cheaper. Only applicable if priceChange == true

priceChangeSince
string <date>

Price changes since the given date. Only applicable if priceChange == true. If no date is provided the current date will be assumed

object

Range of price per square meter in local currency defined by from or to or both

object

Range of price in local currency defined by from or to or both

object

Range of property space in m² defined by from or to or both

object

Range of reconstruction year defined by from or to or both

refurbished
boolean

Property is refurbished

salesStatus
Array of strings
Items Enum: "ImVerkauf" "Unbekannt" "Verkauft" "VorVerkauf"

Status of sales progress

  • ImVerkauf - On Sale
  • Unbekannt - Unknown
  • Verkauft - Sold
  • VorVerkauf - Not yet offered
searchString
string

Search for the given text within the offer descriptions, title, street name, city name, vendor name and vendor company name. Several search words are combined using OR

underfloorHeating
boolean

Underfloor heating is available

object

Range of useable space in m² defined by from or to or both

vendorIsCommercial
boolean

Vendor is an estate agent

object

Range of yield / cap rate in percent defined by from or to or both

analyzedField
string
Default: "PREISPROQM"
Enum: "NUTZFLAECHE" "PREIS" "PREISPROQM" "RENDITE" "TAGEONLINE"

Property attribute to be analyzed

cutOutlier
string
Default: "GEOMAP"
Enum: "GEOMAP" "KEINE" "PERZENTILE"

Method for truncating outliers within the values of analyzedField before the calculation of returnValue

  • GEOMAP - default method, a combination of interquartile range and 0.05 (5%) percentiles and at least 5 items
  • KEINE - no truncation
  • PERZENTILE - cuts the lower and upper outlierPercentile percentile (inclusive). outlierPercentile must be set
outlierPercentile
number <float> decimal places <= 1 ( 0 .. 50 )
Default: 5

Value to calculate the percentile range e.g. value 3.5 means a percentile range from 3.5% to 96.5%. Must be specified together with cutOutlier - PERZENTILE

Responses

Request samples

Content type
application/json
Example
{
  • "coordinate": {
    },
  • "radiusInKm": 1.5,
  • "airConditioningVentilation": true,
  • "balconyTerrace": true,
  • "barrierFree": true,
  • "bathroomWithWindow": true,
  • "builtInKitchen": true,
  • "cellar": true,
  • "constructionStatus": [
    ],
  • "constructionYearRange": {
    },
  • "developments": [
    ],
  • "divisible": true,
  • "elevator": true,
  • "energyConsumptionRange": {
    },
  • "energyEfficiencyStandards": [
    ],
  • "energyRatings": [
    ],
  • "energySources": [
    ],
  • "fireplace": true,
  • "firstSeenDateRange": {
    },
  • "firstTimeUse": true,
  • "freeOfCommission": true,
  • "furnished": true,
  • "garden": true,
  • "guestToilet": true,
  • "heatingTypes": [
    ],
  • "leased": true,
  • "modelHouseAdvertisement": true,
  • "numberOfRoomsRange": {
    },
  • "objectCategories": [
    ],
  • "objectClasses": [
    ],
  • "objectTypes": [
    ],
  • "objectSubtypes": [
    ],
  • "offerTypes": [
    ],
  • "onlineDateRange": {
    },
  • "parkingSpace": true,
  • "preservationOrder": true,
  • "priceChange": true,
  • "priceChangeDirection": "HOCH",
  • "priceChangeSince": "2019-08-24",
  • "pricePerSqmRange": {
    },
  • "priceRange": {
    },
  • "propertySpaceRange": {
    },
  • "reconstructionYearRange": {
    },
  • "refurbished": true,
  • "salesStatus": [
    ],
  • "searchString": "string",
  • "underfloorHeating": true,
  • "usableSpaceRange": {
    },
  • "vendorIsCommercial": true,
  • "yieldRange": {
    },
  • "analyzedField": "NUTZFLAECHE",
  • "cutOutlier": "GEOMAP",
  • "outlierPercentile": 5
}

Response samples

Content type
application/json
{
  • "count": 43,
  • "average": 12.34,
  • "maximum": 12.34,
  • "median": 12.34,
  • "minimum": 12.34,
  • "percentile25": 12.34,
  • "percentile75": 12.34
}