Region

POST locations/regions

Get information on lower division levels, such as borders, population development, the development of unemployment rates, or the average available income per inhabitant.

Example use-cases:

  • Display the borders of divisions on a map
  • Display general information of different division levels
  • Display different charts known from quis.de
  • Use different indicators for your calculations and forecasts

Request

curl -X POST 'https://quis.de/api/v2/locations/regions?api_key=<YOU-API-KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "location": {
      "address": {
        "street": "Gasstraße",
        "houseNumber": "10",
        "postCode": "22761",
        "city": "Hamburg"
      }
    }
  }'
FieldDescriptionTypeRemarks
locationLocation of the propertyLocation

Response

{
  "divisionLevel4": {
    "id": "02",
    "name": "Hamburg",
    "levelDesignation": "Bundesland",
    "geometry": {
      "type": "MultiPolygon",
      "coordinates": [
        [
          [
            [9.8845262,53.580345],
            ...
          ]
        ]
      ]
    }
  },
  "divisionLevel6": {
    "id": "02000",
    "name": "Hamburg",
    "levelDesignation": "Kreisfreie Stadt",
    "geometry": {
      "type": "MultiPolygon",
      "coordinates": [
        [
          [
            [9.8845262,53.580345],
            ...
          ]
        ]
      ]
    }
  },
  "divisionLevel8": {
    "id": "02000000",
    "name": "Hamburg",
    "levelDesignation": "Stadt",
    "geometry": {
      "type": "MultiPolygon",
      "coordinates": [
        [
          [
            [9.8845262,53.580345],
            ...
          ]
        ]
      ]
    }
  },
  "divisionLevel100": {
    "id": "22761",
    "name": "22761",
    "levelDesignation": "Postleitzahl",
    "geometry": {
      "type": "MultiPolygon",
      "coordinates": [
        [
          [
            [9.8845262,53.580345],
            ...
          ]
        ]
      ]
    }
  },
  "divisionLevel8Type": "large_city",
  "currency": "EUR",
  "scores": {
    "overall": 0.87,
    "socialStructure": 0.72,
    "infrastructure": 0.81,
    "rentPrice": 0.92,
    "qualityOfLife": 0.81,
    "dominantPopulationGroups": null,
    "dominantBuildingType": null
  },
  "population": 1801101,
  "broadbandAvailability": {
    "value": 0.98,
    "class": "supplied"
  },
  "futurePotential": 1.0,
  "rentalLaw": {
    "divisionLevel": "divisionLevel8",
    "rentIndexUrl": "https://www.hamburg.de/mietenspiegel/",
    "hasRentIndex": true,
    "hasRentCap": true,
    "hasRentControl": true
  },
  "infrastructure": {
    "dailyNeeds": {
      "score": 0.83,
      "nextSupermarket": null,
      "nextBackery": null,
      "nextRestaurant": null
    },
    "transport": {
      "score": 0.73,
      "nextBusStop": null,
      "nextTrainStation": null,
      "nextAirport": null,
      "nextChargingStation": null
    },
    "education": {
      "score": 0.76,
      "nextChildDayCare": null,
      "nextPrimarySchool": null,
      "nextHighSchool": null,
      "nextGrammarSchool": null
    },
    "healthAndSport": {
      "score": 0.96,
      "recreationAndNatureScore": null,
      "nextFamilyDoctor": null,
      "nextHospital": null,
      "nextPharmacy": null,
      "nextSportFacility": null
    },
    "noisePollution": {
      "score": 0.85,
      "roadLevel": null,
      "trainLevel": null
    }
  },
  "populationDevelopment": {
    "series": [
      {
        "divisionLevel": "divisionLevel8",
        "title": "Hamburg",
        "data": [
          {
            "x": "2011-12-31",
            "y": 100
          },
          {
            "x": "2012-12-31",
            "y": 105
          }
        ]
      },
      {
        "divisionLevel": "divisionLevel2",
        "title": "Deutschland",
        "data": [
          {
            "x": "2011-12-31",
            "y": 100
          },
          {
            "x": "2012-12-31",
            "y": 102
          }
        ]
      }
    ]
  },
  "populationForecast": {
    "series": [
      {
        "divisionLevel": "divisionLevel6",
        "title": "below_20",
        "data": [
          {
            "x": "2011-12-31",
            "y": 100
          },
          {
            "x": "2012-12-31",
            "y": 97
          }
        ]
      },
      {
        "divisionLevel": "divisionLevel6",
        "title": "20_to_29",
        "data": [
          {
            "x": "2011-12-31",
            "y": 100
          },
          {
            "x": "2012-12-31",
            "y": 102
          }
        ]
      },
    ]
  },
  "ageDistribution": {
    "series": [
      {
        "divisionLevel": "divisionLevel8",
        "title": "Hamburg",
        "data": [
          {
            "x": "below_18",
            "y": 0.22
          },
          {
            "x": "18_to_29",
            "y": 0.18
          }
        ]
      },
      {
        "divisionLevel": "divisionLevel8",
        "title": "large_city",
        "data": [
          {
            "x": "below_18",
            "y": 0.22
          },
          {
            "x": "18_to_29",
            "y": 0.18
          }
        ]
      },
    ]
  },
  "populationDevelopmentByAge": {
    "series": [
      {
        "divisionLevel": "divisionLevel8",
        "title": "below_18",
        "data": [
          {
            "x": "2011-12-31",
            "y": 100
          },
          {
            "x": "2012-12-31",
            "y": 105
          }
        ]
      },
      {
        "divisionLevel": "divisionLevel8",
        "title": "18_to_29",
        "data": [
          {
            "x": "2011-12-31",
            "y": 100
          },
          {
            "x": "2012-12-31",
            "y": 102
          }
        ]
      }
    ]
  },
  "migrationBalance": {
    "series": [
      {
        "divisionLevel": "divisionLevel8",
        "title": "immigration",
        "data": [
          {
            "x": "2011-12-31",
            "y": 0.0543
          },
          {
            "x": "2012-12-31",
            "y": 0.0512
          }
        ]
      },
      {
        "divisionLevel": "divisionLevel8",
        "title": "emigration",
        "data": [
          {
            "x": "2011-12-31",
            "y": 0.0543
          },
          {
            "x": "2012-12-31",
            "y": 0.0512
          }
        ]
      }
    ]
  },
  "constructionCompletions": {
    "series": [
      {
        "divisionLevel": "divisionLevel8",
        "title": "one_to_two_apartments",
        "data": [
          {
            "x": "2011-12-31",
            "y": 0.0543
          },
          {
            "x": "2012-12-31",
            "y": 0.0512
          }
        ]
      },
      {
        "divisionLevel": "divisionLevel8",
        "title": "more_than_three_apartments",
        "data": [
          {
            "x": "2011-12-31",
            "y": 0.0543
          },
          {
            "x": "2012-12-31",
            "y": 0.0512
          }
        ]
      }
    ]
  },
  "unemploymentRates": {
    "series": [
      {
        "divisionLevel": "divisionLevel6",
        "title": "unemployment_rate",
        "data": [
          {
            "x": "2011-12-31",
            "y": 0.0543
          },
          {
            "x": "2012-12-31",
            "y": 0.0512
          }
        ]
      },
      {
        "divisionLevel": "divisionLevel6",
        "title": "minimum_benefit_rate",
        "data": [
          {
            "x": "2011-12-31",
            "y": 0.0543
          },
          {
            "x": "2012-12-31",
            "y": 0.0512
          }
        ]
      }
    ]
  },
  "immigrantRates": {
    "series": [
      {
        "divisionLevel": "divisionLevel8",
        "title": "Hamburg",
        "data": [
          {
            "x": "2011-12-31",
            "y": 0.0543
          },
          {
            "x": "2012-12-31",
            "y": 0.0512
          }
        ]
      },
      {
        "divisionLevel": "divisionLevel2",
        "title": "Deutschland",
        "data": [
          {
            "x": "2011-12-31",
            "y": 0.0543
          },
          {
            "x": "2012-12-31",
            "y": 0.0512
          }
        ]
      }
    ]
  },
  "availableIncome": {
    "series": [
      {
        "divisionLevel": "divisionLevel8",
        "title": "Hamburg",
        "data": [
          {
            "x": "2019-12-31",
            "y": 20000.00
          },
        ]
      },
      {
        "divisionLevel": "divisionLevel2",
        "title": "Deutschland",
        "data": [
          {
            "x": "2019-12-31",
            "y": 20000.00
          },
        ]
      }
    ]
  },
  "incomeDevelopment": {
    "series": [
      {
        "divisionLevel": "divisionLevel8",
        "title": "Hamburg",
        "data": [
          {
            "x": "2011-12-31",
            "y": 100
          },
          {
            "x": "2012-12-31",
            "y": 105
          }
        ]
      },
      {
        "divisionLevel": "divisionLevel2",
        "title": "Deutschland",
        "data": [
          {
            "x": "2011-12-31",
            "y": 100
          },
          {
            "x": "2012-12-31",
            "y": 102
          }
        ]
      }
    ]
  },
  "meta": {
    "url": "https://quis.de/geo/53.56238135,9.91097785903008",
    "version": "2.4.0"
  }
}
FieldDescriptionTypeRemarks
divisionLevel4The level 4 divisionDivision
divisionLevel6The level 6 divisionDivision
divisionLevel8The level 8 divisionDivision
divisionLevel100The level 100 divisionDivision
divisionLevel8TypeClassification of the division level 8's sizeDivisionLevel8Type
currencyThe local currencyCurrencyImportant for all kind of prices and price charts
scoresThe scores for the level 8 divisionScores
populationThe population of the level 8 divisioninteger
broadbandAvailabilityThe broadband availability of the level 8 divisionPercentageClasspossible values for broadbandAvailability.class are not_supplied, partially_supplied, largely_supplied, mainly_supplied, supplied
futurePotentialThe future potential of the level 6 divisionScore
rentalLawThe rental law of the regionRentalLaw
infrastructureThe infrastructure of the level 8 divisionInfrastructure
populationDevelopmentThe relative population development since the year 2011 for different division levelsChart
populationForecastThe demographic population forecast relative to the base year 2017 for the level 6 divisionChartseries[i].title`s enum: AgeGroup
ageDistributionThe demographic age distribution of the level 8 division and the divisionLevel8TypeChartseries[i].data[i].x`s enum: AgeGroup
series[i].title could be a DivisionLevel8Type
populationDevelopmentByAgeThe relative demographic population development based on 2011 for the level 8 divisionChartseries[i].title`s type is AgeGroup
migrationBalanceMigration balance and of recent years for the level 8 divisionChartpossible series[i].title`s enum: immigration, emigration, net_migration
apartmentConstructionsNumber of apartments per building size and 10,000 inhabitants built in recent years for the level 8 divisionChartpossible series[i].title`s enum: one_to_two_apartments, more_than_three_apartments, total
unemploymentRatesUnemployment developement and minimum security rates of recent years for the level 6 divisionChartpossible series[i].title`s enum: unemployment_rate, minimum_benefit_rate
immigrantRatesImmigrant rates of recent years for different divisionsChart
availableIncomeAverage available income per inhabitant for different divisionsChart
incomeDevelopmentThe relative income development (base year 2011) for different divisionsChart
metaMeta information of the APIMeta

RentalLaw

FieldDescriptionTypeRemarks
divisionLevelThe division level of the rental lawDivisionLevel
rentIndexUrlUrl to the official rent indexstring
hasRentIndexDoes the level 8 Division has a rent index?boolean
hasRentCapDoes the level 8 Division has a rental cap?boolean
hasRentControlDoes the level 8 Division has a rental control?boolean