Building Projects

POST building_projects

Returns building projects that match the specified search criteria.

Request

curl -X POST 'https://api.pricehubble.com/api/v1/building_projects' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074' \
  -d '{
    "coordinates": {
        "latitude": 47.773,
        "longitude": 6.23344
    },
    "radius": 5000,
    "isResidential": true,
    "status": [
        "construction_started"
    ],
    "constructionStartYear": {
        "min": 2017
    },
    "offset": 0,
    "limit": 10,
    "countryCode": "CH"
}'

Request Fields

Field	Description	Type	Remarks
coordinates	Filter on building project location. Matches building projects that lie within the circle defined by coordinates and radius	Coordinates
radius	Radius of the circle around coordinates, in meters	integer	min: 0, max: 30'000, default: 3'000
isResidential	Filter on the building project's isResidential flag	boolean	Do not set this field if you want to search for building projects of any kind (residential, non-residential, unknown). Not available in AT
isCommercial	Filter on the building project's isCommercial flag	boolean	Do not set this field if you want to search for building projects of any kind (commercial, non-commercial, unknown). Not available in AT
status	Filter on building project status. Matches building projects which have one of the specified status	array of BuildingProjectStatus
constructionStartYear.min	Lower bound for construction start date	integer	Format: YYYY. Not available in AT
constructionStartYear.max	Upper bound for construction start date	integer	Format: YYYY. Not available in AT
numberOfApartments.min	Lower bound the for number of apartments affected	integer	min: 0, max: 1'000
numberOfApartments.max	Upper bound the for number of apartments affected	integer	min: 0, max: 1'000
numberOfHouses.min	Lower bound for the number of (single-family) houses to be built	integer	min: 0, max: 500
numberOfHouses.max	Upper bound for the number of (single-family) houses to be built	integer	min: 0, max: 500
numberOfBuildings.min	Lower bound for the number of buildings affected	integer	min: 0, max: 500. Not available in AT
numberOfBuildings.max	Upper bound for the number of buildings affected	integer	min: 0, max: 500. Not available in AT
offset	Offset of the query (allows pagination)	integer	min: 0, max: 1'000, default: 0
limit	Maximum number of results to return	integer	min: 0, max: 500, default: 10
countryCode	ISO country code	string

BuildingProjectStatus

projected, building_permit_requested, building_permit_issued, construction_started construction_ended or abandoned

Response

{
    "items": [
        {
            "constructionStartDate": "2017",
            "distance": 313,
            "fullDescription": "Neubau/Ersatzbau eines 5-1/2-/6-1/2-Zimmer-Einfamilienhauses in Einsteinmauerwerk/Massivbau mit einem Schrägdach und Betoneindeckung. Einbau einer Wärmepumpe und Fussbodenheizung. Umgebungsveränderung, ein Autoabstellplatz und Veloabstellplatz im Freien.",
            "location": {
                "address": {
                    "city": "Zürich",
                    "houseNumber": "64",
                    "postCode": "8037",
                    "street": "Trottenstrasse"
                },
                "coordinates": {
                    "latitude": 47.3959884643555,
                    "longitude": 8.5192985534668
                }
            },
            "numberOfApartments": 6,
            "numberOfBuildings": 1,
            "numberOfFloorsInBuilding": 3,
            "provider": "baublatt",
            "shortDescription": "Ersatzneubau Einfamilienhaus",
            "status": "construction_started",
            "title": "Ersatzneubau Einfamilienhaus",
            "isPreciselyLocated": true,
        }
    ],
    "totalItems": 1
}

Response fields

Field	Description	Type	Remarks
totalItems	Total number of matching building projects found	integer
items	List of matching building projects, sorted by distance in ascending order	array of BuildingProjects	empty array if no results

BuildingProject

Field	Description	Type	Remarks
title	Title of the building project (in the local language)	string
shortDescription	Short description of the building project (in the local language)	string
fullDescription	Full description of the building project (in the local language)	string
location		Location
distance	Distance in meters to the coordinates specified in the request	integer
isResidential	Is the building project of residential nature, e.g. new apartments are being built?	boolean
isCommercial	Is the building project of commercial nature, e.g. new offices are being built?	boolean
status	Status of the building project	BuildingProjectStatus
buildingPermitRequestedDate	The date the building permit was requested	date	Format: YYYY-MM-DD. Not available in AT
buildingPermitIssuedDate	The date the building permit was issued	date	Format: YYYY-MM-DD. Not available in AT
constructionStartDate	Start date of the construction	date	Format: YYYY-MM-DD
constructionEndDate	End date of the construction	date	Format: YYYY-MM-DD
numberOfHouses	The number of (single-family) houses affected by this building project, e.g. the number of houses to be built	integer	Not available in AT
numberOfApartments	The number of apartments affected by this building project, e.g. the number of apartments to be built	integer
numberOfBuildings	The number of buildings affected by this building project, e.g. the number of buildings to be built	integer	Not available in AT
numberOfFloorsInBuilding	The number of floors in the building. If the building project encompasses multiple buildings, the field indicates the number of floors in the highest building	integer	Not available in AT
provider	Data provider/source	string	Examples: sitadel, baublatt, osm
isPreciselyLocated	Is the point precisely located	boolean
energyLabel	Energy label	string	Only available in AT
numberOfRoomsRange	Min and max number of rooms	string	Only available in AT
livingAreaRange	Min and max living area	FloatValueRange	Only available in AT
unitPriceRange	Min and max unit price	FloatValueRange	Only available in AT