Property Info

POST property_info

Returns information about the property at the specified location.

This endpoint is typically used in combination with the Dossier Creation endpoint to pre-fill / auto-complete an input form before creating the dossier.

Request

curl -X POST 'https://api.pricehubble.com/api/v1/property_info' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074' \
  -d '{
  "location": {
    "address": {
       "street": "Haarlemmerstraat",
       "houseNumber": "82-H",
       "postCode": "1013EV",
       "city": "Amsterdam"
   }
  },
  "dossierId": "3bac39b8-2d84-4ae9-a693-40502071ea5d",
  "countryCode": "NL"
}'

Field	Description	Type	Remarks
location	Location of the property	Location	Only address is used for NL & FR, only uprn is used for UK, the rest has no effects
dossierId	ID of the dossier	string	If this field is added to the request, then the location must be the same as the dossier's location (address or coordinates)
countryCode	ISO country code	string	Only NL, UK & FR are supported

Supported address format for NL:

• postCode parameter: Post codes with space ("1234 AB") or without space ("1234AB") are being accepted
• houseNumber parameter:
  • House number additions (huisnummer toevoeging) need to be separated by hyphen from house numbers (example: "100-1")
  • Floor numbers need to be written in Arabic numerals; Roman numerals are not accepted (valid: "100-1", invalid: "100-I")

Response

{
  "livingArea": 100.0,
  "buildingYear": 2012,
  "energyLabel": "a"
}

Field	Description	Type	Remarks
propertyType	Property type	PropertyType	Only propertyType.code is exposed, for UK & FR only
livingArea	Net living area of the property	float
buildingYear	Building year of the property	integer	For NL & FR only
energyLabel	Energy label	string	Possible values: For NL: a_plus_plus_plus, a_plus_plus, a_plus, a, b, c, d, e, f, g For UK & FR: a, b, c, d, e, f, g
landArea	Land area of the property	float	For UK & FR only