Skip to content
HuislyHuisly
Huisly Data
Sign in
StatusLiveGET /data/v1/properties/lookup

Property API

The Property API looks up one Dutch property by its slug. A property is one address in the Netherlands.

Create accountRead the docs
Sample API requests. Sample data from the published API contract.
Property

Request

GET/data/v1/properties/lookup?slug=amsterdam-keizersgracht-999-2-k8d3m2p9x4qz

X-API-Key: YOUR_API_KEY

Response

{
  "slug": "amsterdam-keizersgracht-999-2-k8d3m2p9x4qz",
  "bagVerblijfsobjectId": "0363019999999999",
  "houseNumber": "999",
  "houseLetter": null,
  "houseNumberAddition": "2",
  "location": {
    "municipality": {"slug": "amsterdam-gsxxzjaz98rj", "displayName": "Amsterdam"},
    "locality": {"slug": "amsterdam-c7sh2t", "displayName": "Amsterdam"},
    "district": {
      "slug": "grachtengordel-west-mavt2wcj84gj",
      "displayName": "Grachtengordel-West"
    },
    "neighborhood": {
      "slug": "langestraat-e-o-jtvr6xz675kh",
      "displayName": "Langestraat e.o."
    },
    "postalCode": {"slug": "1015-cc-7j7dqke625ht", "displayName": "1015 CC"},
    "publicSpace": {
      "slug": "keizersgracht-9z4dabpr",
      "displayName": "Keizersgracht"
    }
  },
  "geometry": {"type": "Point", "coordinates": [4.886431, 52.376893]},
  "livingAreaM2": 92,
  "constructionYear": 1932,
  "parcels": [{"areaM2": 215}],
  "building": {"footprintAreaM2": 187.42, "unitCount": 4},
  "activeListings": {
    "forSale": {
      "id": "0b7c7a8e-4f3e-4a51-9a39-2f1d3f5c6a10",
      "priceCents": "42500000"
    },
    "forRent": null
  },
  "dataHidden": false
}

200 OK2 creditsSample response

Sample data from the published API contract.

  • 2 creditsper lookup
  • 6places, each with its slug
  • 16digit BAG identification, as a string
  • WGS 84point, as longitude and latitude

What a lookup returns

  • Address

    The slug, house number, house letter and house number addition.

  • Location

    Municipality, locality, district, neighbourhood, postal code and public space, each with the slug the listing search takes.

  • BAG identification

    The identification of the property's verblijfsobject, to join other data about the same verblijfsobject on.

  • Position

    A point in WGS 84, as longitude and latitude.

  • Registered facts

    Living area, construction year, the cadastral parcels with their area, and the building with its footprint area and number of units.

  • Open listings

    The ID and price of the open listing for sale and of the one for rent, when there is one.

nullA value that is unknown is null.

Identified by its slug

400 unknown_property

A property is identified by its slug. A slug that no property has gets a 400 error with the code unknown_property.

Works with the Aggregator API

propertySlug

Listings from the Aggregator API carry the slug of their property in propertySlug, which the lookup takes.

Aggregator API

Unavailable data

dataHidden: true

The data of some properties is unavailable. The lookup still finds the property and the response keeps its shape: dataHidden is true, the address, places and location are given as for any property, and the other fields are null or empty. Whether a property's data is available can change from one request to the next.

Call it from your code

Cost

A lookup costs 2 credits, also for a property whose data is unavailable. A failed request costs nothing.

Read the docs

curl "https://api.huisly.nl/data/v1/properties/lookup?slug=amsterdam-keizersgracht-999-2-k8d3m2p9x4qz" \
  -H "X-API-Key: YOUR_API_KEY"
const params = new URLSearchParams({ slug: "amsterdam-keizersgracht-999-2-k8d3m2p9x4qz" })
const response = await fetch(`https://api.huisly.nl/data/v1/properties/lookup?${params}`, {
  headers: { "X-API-Key": "YOUR_API_KEY" },
})
const body = await response.json()
import requests

response = requests.get(
    "https://api.huisly.nl/data/v1/properties/lookup",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"slug": "amsterdam-keizersgracht-999-2-k8d3m2p9x4qz"},
)
body = response.json()

Try it with free credits

A new organization can claim free trial credits to try the API.

Create accountView pricing

Questions

Book a callor emailsales@huisly.nl