HuizenZoeker API

API-sleutel aanvragen
Plaats met de HuizenZoeker API het gevonden aanbod van HuizenZoeker op uw eigen website.

Voorbeeld 1: Kaart, woningen te koop in Enkhuizen

Plaats op uw website een kaart met daarop het aanbod in uw buurt.
Download PHP broncode

Bezig met laden...

Voorbeeld 2: Galerij, woningen te koop in Delfzijl

Plaats een galerij met het aanbod van koopwoningen in uw buurt in de huisstijl van uw eigen website.
Download PHP broncode

Rijksweg 57 A Rijksweg 57 A 9934 PC Delfzijl
€ 192.500
Koetshuis 1 Koetshuis 1 9932 CG Delfzijl
€ 175.000
Klaverweide 22 Klaverweide 22 9932 JB Delfzijl
€ 139.900k.k
Johan Van Den Kornputplein 12 Johan Van Den Kornputplein 12 9934 EA Delfzijl
€ 189.000
Mondsteen 55 Mondsteen 55 9934 LV Delfzijl
€ 137.500
Simonszand 57 Simonszand 57 9931 AP Delfzijl
€ 87.500
Kustweg 577 Kustweg 577 9933 AZ Delfzijl
€ 107.000

Hoe werkt het?

Via de HuizenZoeker API kunt u het totale huizenaanbod van HuizenZoeker doorzoeken en de resultaten tonen op uw eigen website. U kunt zelf bepalen waar u naar zoekt en hoe u de resultaten weergeeft op uw website.

De HuizenZoeker API werkt via HTTP-requests. U stuurt een HTTP-request naar onze server waarbij u de gewenste GET-variabelen meestuurt (zie de voorbeelden onderaan de pagina). De resultaten van uw aanvraag worden vervolgens weergeven in XML of JSON.

Om requests te kunnen versturen dient u in het bezit te zijn van een HuizenZoeker API-sleutel. Deze kunt u hier aanvragen.

Een request begint altijd met ' http://www.huizenzoeker.nl/api/v2/?apisleutel=...&module=...&get=... '.
De parameters apisleutel, module en get dienen verplicht meegestuurd te worden bij iedere request:

Standaard worden de resultaten weergegeven in XML. U kunt ook kiezen voor een uitvoer in JSON, welke met name geschikt is voor aanvragen via JavaScript.
Hiervoor dient u het volgende mee te geven aan de HTTP request: ' &output=json '

Onderaan deze pagina vindt u diverse voorbeelden hoe u informatie met de API kunt opvragen.


Modulen

Hieronder staan de modulen van de HuizenZoeker API beschreven. Elke module bevat een bepaald soort informatie. Een module is opgedeeld in functies. De functie geeft aan welke informatie u uit de module wilt halen. U kunt deze informatie verder filteren door één of meer parameters mee te geven, welke staan beschreven achter de betreffende functie.

Bij sommige parameters kunt u zowel een naam als een id als waarde opgeven. Bijvoorbeeld aan de parameter provincie kunt u de waarde Friesland of FR meegeven. De namen en id's van provincies, gemeenten, plaatsen en wijken zijn op te vragen via de module 'Locaties'.


Module 'Locaties'

De module Locaties bevat o.a. de namen, id's, latitude en longitude coördinaten van provincies, gemeenten, plaatsen en wijken. Deze informatie kan gebruikt worden om informatie uit de module Objecten op te vragen. Als u de parameter ' &toon=statistiek ' meegeeft worden er eveneens statistieken (aantal objecten) meegestuurd met de resultaten.


Functie Omschrijving Parameter Waarde Beschrijving
Provincies Alle provincies van Nederland. provincie naam of id informatie over deze provincie.
Gemeenten Alle gemeenten van Nederland. provincie naam of id gemeenten in deze provincie.
    gemeente naam of id informatie over deze gemeente.
Plaatsen* Alle plaatsen in een provincie. provincie naam of id plaatsen in deze provincie.
    gemeente naam 1) of id plaatsen in deze gemeente.
    plaats naam 1) of id informatie over deze plaats.
Wijken* Alle wijken in een plaats. provincie naam of id plaatsen in deze provincie.
    plaats naam 1) of id wijken van deze plaats.
    wijk naam 2) of id informatie over deze wijk.
Query 3) Haalt de locatie uit de tekst. q locatie plaats of postcode met eventueel straatnaam en huisnummer.
    at 'koop' of 'huur' type van aanbod bij een specifiek adres.

* Deze functie vereist minimaal één parameter.

1) Indien u de naam van de gemeente/plaats opgeeft, dan dient u eveneens de naam of het id van de provincie mee te geven. Indien u het id van de gemeente/plaats opgeeft hoeft u de provincie niet op te geven. Voorbeelden:

  • provincie=Gelderland&gemeente=Ede
  • provincie=GE&gemeente=Ede
  • gemeente=300
  • provincie=Gelderland&plaats=Ede
  • provincie=GE&plaats=Ede
  • plaats=1280


2) Indien u de naam van de wijk opgeeft, dan dient u eveneens de naam of het id van de plaats mee te geven. Als u de naam van de plaats meegeeft, dient u ook de naam of het id van de provincie mee te geven. Indien u het id van de wijk opgeeft hoeft u de provincie niet op te geven. Voorbeelden:

  • provincie=Gelderland&plaats=Ede&wijk=Bloemenbuurt
  • plaats=1280&wijk=Bloemenbuurt
  • wijk=2280204


3) Geeft de plaats met eventuele straat terug. Een lijst van plaatsen wordt getoond als een plaats vaker gevonden is. Bij een specifiek adres wordt (mits gevonden) het object getoond als de parameter ' at ' ook meegestuurd wordt. Alleen een straatnaam meesturen kan, maar de locatie wordt alleen gezien als de straatnaam uniek is, anders wordt de straatnaam als plaatnaam gezien. Voorbeelden:

  • q=Hengelo
  • q=Amsterdam+Prinsengracht
  • q=Rotterdam+Straatweg+206&at=koop


Module 'Objecten'

De module Objecten bevat alle objecten (woningen, garages, kantoren, etc.) die op HuizenZoeker te vinden zijn. Als u de parameter ' &view=filters ' meegeeft worden er eveneens filters meegestuurd met de resultaten. Met deze filters kunt u de gevonden resultaten verder filteren.


Functie Omschrijving Parameter Waarde Beschrijving
Koop Alle koopwoningen in Nederland. provincie* naam of id objecten in deze provincie.
    gemeente* naam of id objecten in deze gemeente.
    plaats* naam 1) of id objecten in deze plaats.
    wijk naam 2) of id objecten in deze wijk.
    pc* 4 cijfers en 2 letters objecten beginnend deze postcode (cijfers verplicht).
    adr naam objecten met dit adres/in deze straat.
    pv numeriek prijs vanaf.
    pt numeriek prijs t/m.
    wov numeriek woonoppervlakte vanaf.
    wot numeriek woonoppervlakte tot.
    pov numeriek perceeloppervlakte vanaf.
    pot numeriek perceeloppervlakte tot.
    bjv numeriek bouwjaar vanaf.
    bjt numeriek bouwjaar t/m.
    anbd numeriek aanbod sinds aantal dagen.
    bs 'nieuw' of 'bestaand' nieuwbouw of bestaande bouw.
    ka numeriek minimum aantal kamers.
    so id soort object.
    to id type object (parameter 'so' verplicht).
    oh 'j' alleen objecten met openhuis.
    pw 'j' alleen objecten met prijs wijziging.
    ll 'j' alleen objecten met geolocatie (latitude en longitude).
    lat 3) numeriek objecten rondom latitude geolocatie.
    lng 3) numeriek objecten rondom longitude geolocatie.
    strl 4) numeriek objecten rondom een geolocatie binnen een straal.
    lm numeriek maximum aantal resultaten, maximum limiet is 100.
    p numeriek paginanummer waarmee door de resultaten genavigeerd kan worden.
    sort id sorteren op, zie functie Sortering voor de mogelijkheden.
Huur Alle huurwoningen in Nederland. Gelijk aan functie Koop. De parameters ' pv ' en ' pt ' zijn hierbij de huurprijzen per maand.
SoortType Alle soorten en type objecten. so id typen van deze soort.
    to id alleen dit type.
Sortering Sorterings mogelijkheden. Sorteringsrichting kan aangepast worden door bij het id ' -a ' of ' -d ' te gebruiken.

* Een provincie, gemeente, plaats of postcode is verplicht.


1) Indien u de naam van de plaats opgeeft, dan dient u eveneens de naam of het id van de provincie mee te geven. Indien u het id van de plaats opgeeft hoeft u de provincie niet op te geven. Voorbeelden:

  • provincie=Gelderland&gemeente=Ede
  • provincie=GE&gemeente=Ede
  • plaats=1280


2) Indien u de naam van de wijk opgeeft, dan dient u eveneens de naam of het id van de plaats mee te geven. Als u de naam van de plaats meegeeft, dient u ook de naam of het id van de provincie mee te geven. Indien u het id van de wijk opgeeft hoeft u de provincie niet op te geven. Voorbeelden:

  • provincie=Gelderland&plaats=Ede&wijk=Bloemenbuurt
  • plaats=1280&wijk=Bloemenbuurt
  • wijk=2280204


3) Deze parameter werkt alleen als deze in de combinatie van de parameters ' lat ' en ' lng ' en ' strl ' gebruikt wordt. U kunt hiermee objecten rondom deze geolocatie opvragen. Voorbeelden:

  • lat=52.512794&lng=6.091539&strl=5
  • lat=52.090833&lng=5.122222&strl=3&pv=100000
  • lat=52.090833&lng=5.122222&strl=2&pv=100000&bjv=1980


4) Deze parameter kunt u gebruiken om in een straal van x aantal kilometers rondom een geolocatie te zoeken. Dit kan een plaats, postcode of een zelf opgegeven locatie (latitude en longitude) zijn. De straal mag maximaal 15 kilometer zijn. Voorbeelden:

  • provincie=Gelderland&plaats=Ede&strl=5
  • lat=52.512794&lng=6.091539&strl=5
  • pc=3551&strl=3.5


Voorbeeld aanvragen

Alle plaatsen in de gemeente Ede, Gelderland.
http://www.huizenzoeker.nl/api/v2/?apisleutel=...&module=Locaties&get=Plaatsen&provincie=GE&gemeente=Ede

Alle wijken in de plaats Delfzijl.
http://www.huizenzoeker.nl/api/v2/?apisleutel=...&module=Locaties&get=Wijken&provincie=GR&plaats=Delfzijl

Alle koopwoningen tussen de € 100.000 en € 200.000 in de plaats Hoek van Holland.
http://www.huizenzoeker.nl/api/v2/?apisleutel=...&module=Objecten&get=Koop&provincie=ZH&plaats=Hoek+van+Holland&pv=100000&pt=200000

Alle koopwoningen met een bouwjaar tussen 1972 en 1980, met minimaal woonoppervlakte van 100 m² in de gemeente Utrecht.
http://www.huizenzoeker.nl/api/v2/?apisleutel=...&module=Objecten&get=Koop&provincie=UT&gemeente=Utrecht&bjv=1972&bjt=1980&wov=100

API-sleutel aanvragen