Ga naar inhoud
HuislyHuisly
Huisly Data
Inloggen
StatusLiveGET /data/v1/properties/lookup

Property API

De Property API vraagt één Nederlands adres op via zijn slug.

Account aanmakenLees de documentatie
Voorbeeldverzoeken aan de API. Voorbeelddata uit het gepubliceerde API-contract.
Adres

Verzoek

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

X-API-Key: YOUR_API_KEY

Antwoord

{
  "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 creditsVoorbeeldantwoord

Voorbeelddata uit het gepubliceerde API-contract.

  • 2 creditsper opvraging
  • 6plaatsen, elk met zijn slug
  • 16cijfers BAG-identificatie, als tekst
  • WGS 84punt, met lengte- en breedtegraad

Wat een opvraging teruggeeft

  • Adres

    De slug, het huisnummer, de huisletter en de huisnummertoevoeging.

  • Locatie

    Gemeente, woonplaats, wijk, buurt, postcode en openbare ruimte, elk met de slug die de zoekopdracht naar advertenties gebruikt.

  • BAG-identificatie

    De identificatie van het verblijfsobject van het adres, om andere data over hetzelfde verblijfsobject aan te koppelen.

  • Positie

    Een punt in WGS 84, met lengte- en breedtegraad.

  • Geregistreerde gegevens

    Woonoppervlak, bouwjaar, de kadastrale percelen met hun oppervlakte, en het gebouw met de oppervlakte van zijn grondvlak en het aantal verblijfsobjecten.

  • Open advertenties

    Het ID en de prijs van de open advertentie te koop en van die te huur, als die er is.

nullEen onbekende waarde is null.

Aangeduid met zijn slug

400 unknown_property

Een adres wordt aangeduid met zijn slug. Een slug die bij geen enkel adres hoort, geeft een 400-fout met de code unknown_property.

Werkt met de Aggregator API

propertySlug

Advertenties uit de Aggregator API hebben de slug van hun adres in propertySlug, die de opvraging gebruikt.

Aggregator API

Niet beschikbare gegevens

dataHidden: true

De gegevens van sommige adressen zijn niet beschikbaar. De opvraging vindt het adres dan nog steeds en het antwoord houdt zijn vorm: dataHidden is true, het adres, de plaatsen en de locatie staan erin zoals bij elk adres, en de andere velden zijn null of leeg. Of de gegevens van een adres beschikbaar zijn, kan van het ene verzoek op het andere veranderen.

Roep hem aan vanuit je code

Kosten

Een opvraging kost 2 credits, ook voor een adres waarvan de gegevens niet beschikbaar zijn. Een mislukt verzoek kost niets.

Lees de documentatie

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()

Probeer het met gratis credits

Een nieuwe organisatie kan gratis proefcredits claimen om de API uit te proberen.

Account aanmakenBekijk de prijzen

Vragen

Gesprek inplannenof mailsales@huisly.nl