Funda API Documentatie

 

Versies

Datum

Versienummer

Auteur

Toelichting

15-05-2009

1.0

Jan Jongboom

Initiële versie

19-05-2009

1.01

Jan Jongboom

Plaatsvarianten en acceptatie url toegevoegd

 

Toelichting

De funda api is een verzameling (RESTful) webservices die kunnen worden gebruikt door geautoriseerde partners om informatie uit de databases van funda op een gestructureerde manier te benaderen.

In dit document staat een beschrijving van de beschikbare services, met syntax, voorbeeldaanroep, parameters en response.

Plaatsen in een aanroep waar u uw autorisatiesleutel dient in te voeren zijn aangegeven door XXXXXX.

Op basis van uw autorisatiesleutel kunnen andere restricties gelden dan in deze documentatie vermeld.

Technische ondersteuning

Neem voor technische ondersteuning contact op met funda real estate, afdeling product development.

Funda Helpdesk

helpdesk@funda.nl

020 561 82 29

Locatie van de api

Omgeving

Locatie

Test

http://next.funda.nl/api/

Acceptatie

http://api2.funda.acc.funda.nl/

Live

http://partnerapi.funda.nl/

 


 

1.          Aanbod api

1.1       Recent aanbod

Voor het ophalen van objecten van de funda sites, kan gebruik gemaakt worden van de aanbod api. Hierin kan er gefilterd worden op bepaald aanbod dat aan een selectie criteria voldoet. Per aanroep worden er maximaal 25 objecten teruggegeven.

Voorbeeld van een aanroep

/Aanbod.svc/recent/XXXXXX/?type=koop&zo=/zaandam/appartement/250000-300000/nieuwbouw/&since=20090101T1200

Deze aanroep retourneert alle nieuwbouw appartementen in Zaandam, tussen de 250.000 en 300.000 euro, die vanaf 1 januari 2009 12:00 geplaatst zijn; gesorteerd op publicatiedatum van nieuw naar oud.

Parameters

De volgende parameters zijn beschikbaar:

/Aanbod.svc/recent/XXXXXX/?type={soort aanbod}&zo={filters}&since={sinds}

Naam

Beschrijving

Mogelijke waardes

Soort aanbod

Het aanbodtype dat wordt gezocht

koop; huur; nieuwbouw; recreatie; europe

Filters

Criteria voor de zoekopdracht

Zie volgende sectie

Sinds

Alleen aanbod tonen dat na deze datum op funda is geplaatst

Formaat: yyyyMMddTHHmm

20090515T1016

 

Criteria voor de zoekopdracht

!         Een zoekopdracht volgt dezelfde syntax als de resultaatpagina op funda. Voor een juiste syntax kan de gewenste zoekopdracht worden uitgevoerd op de funda website, en wordt de zoekopdracht uit de url gekopieerd.

Een zoekopdracht volgt een vast patroon. Deze bestaat uit:

1.     Een slash (/)

2.     Een geografische indicatie (bijvoorbeeld ‘heel-nederland’, ‘amsterdam’, ‘provincie-noord-holland’, ‘regio-groot-amsterdam’ of ‘zaandam/drostendiep’. Het is ook mogelijk om postcodes te gebruiken (‘1508HB’, ‘1508H’ of ‘1508’))

3.     Een straal (om net buiten de geografische indicatie te zoeken (bijvoorbeeld ‘+10km’))

4.     Prijsindicator (bijvoorbeeld ‘100000-200000’, ‘0-400000’, of ‘200000+’)

5.     Kenmerkindicatoren (bijvoorbeeld ‘appartement’, ‘zwembad’, ‘3+kamers’, ‘in-woonwijk’)

6.     Een afsluitende slash (/)

Elke indicator wordt gevolgd door een slash. Het is mogelijk om meerdere kenmerkindicatoren te gebruiken.[1]

!         De geografische indicator is verplicht, de overige indicatoren zijn optioneel.

Het is ook mogelijk om meerdere geografische indicaties te gebruiken, maar dan gescheiden door komma’s (,). Hierbij geldt een maximum van 5 indicaticaties.

!         Het is niet mogelijk een straal te gebruiken, bij het gebruik van meerdere geografische indicaties.

!         Het is niet mogelijk om verschillende types gebieden door elkaar te gebruiken (zoals provincies en regio’s, of postcodes en plaatsen)

<

Voorbeeld van een aanroep met meerdere geografische locaties:

/zaandam,amsterdam/100000-20000/3+kamers/appartement/zwembad/in-woonwijk/

Response

Er wordt een bericht teruggestuurd welke voldoet aan het volgende contract:

<feed xmlns="http://funda.nl/api/2009-05-12" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">

       <Objects xmlns:a="http://funda.nl/api/feeds/2009-05-12">

             <Object>

                    <a:Adres> </a:Adres>

                    <a:Broncode> </a:Broncode>

                    <a:HoofdFoto> </a:HoofdFoto>

                    <a:Huisnummer> </a:Huisnummer>

                    <a:HuisnummerToevoeging> </a:HuisnummerToevoeging>

                    <a:Id> </a:Id>

                    <a:Plaats> </a:Plaats>

                    <a:Postcode> </a:Postcode>

                    <a:Prijs> </a:Prijs>

                    <a:PrijsGeformatteerd> </a:PrijsGeformatteerd>

                    <a:PublicatieDatum> </a:PublicatieDatum>

                    <a:Straat> </a:Straat>

                    <a:Url> </a:Url>

             </Object>

       </Objects>

       <TotaalAantalObjecten> </TotaalAantalObjecten>

</feed>

Naam

Beschrijving

Mogelijke waardes

Adres

Het adres van het object, incl. huisnummer en toevoeging

Griftland 1 bis

Broncode

De afkomst van het object

NVM, LMV, VBO, VGM, EXT

Hoofdfoto

Url van de hoofdfoto op funda (thumbnail)

Een url. Leeg bij geen waarde.

Huisnummer

Het nummer van het object (integer)

18; 2119

Id

Het unieke id zoals bij funda bekend

00000000-0000-0000-000000

Plaats

De plaats waar het object gevestigd is

’s Gravenhage

Baflo

Postcode

De 6PPC van het object

1200AB; 1921XX

Prijs

De koopprijs van het object als integer.[2]

420000; 120000

PrijsGeformatteerd

De volledige koopprijs van het object, inclusief relevante informatie. Opgemaakt als html, met span elementen voor elk onderdeel

€ 100.000 k.k.

€ 300.000 – 400.000 v.o.n.

€ 180.000 k.k. / € 750 p/mnd

PublicatieDatum

De datum wanneer het object op funda is geplaatst.

Formaat:

yyyy-MM-ddTHH:mm

(2009-05-15T12:00)

Straat

De straatnaam van het object

Boere Jonkerplein

Url

De url van het object op funda

 


 

Naam

Beschrijving

Mogelijke waardes

TotaalAantalObjecten

Aantal objecten in de funda database dat aan de zoekopdracht voldoet

Elk numeriek getal


 

 

 



 

2.          Zoektermen

2.1       Geografisch

Voor het ophalen van geografische informatie, gebruikt om zoekopdrachten op de Aanbod api te ondersteunen, faciliteert funda de geo-api, waarmee informatie zoals plaatsen, provincies of regio’s kunnen worden opgehaald.

Voorbeeld van een aanroep

/feeds/Zoektermen.svc/geo/XXXXXX/plaats/noord-holland/

Deze aanroep retourneert alle plaatsen in de provincie noord-holland.

Parameters

De volgende parameters zijn beschikbaar:

/feeds/Zoektermen.svc/geo/XXXXXX/{soort}/{filter}/

Naam

Beschrijving

Mogelijke waardes

Soort

Het soort aanbod dat gevraagd wordt

plaats; provincie

Filter

Optioneel

Alleen toepasbaar wanneer gezocht op plaats. Filtert op provincie.

noord-holland; utrecht; voor een lijst met alle waardes, zie geo api.

 

Response

Er wordt een bericht teruggestuurd welke voldoet aan het volgende contract:

<feed xmlns="http://funda.nl/api/zoektermen/2009-03-16" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">

       <Objects>

             <Object>

                    <Description> </Description>

                    <Parent> </Parent>

                    <UriParameter> </UriParameter>

             </Object>

       </Objects>

</feed>

Naam

Beschrijving

Mogelijke waardes

Description

Naam van het geo-object, dat gebruikt kan worden om aan gebruikers te tonen

’s Gravenhage; Utrecht; etc.

Parent

De naam van het bovenliggende object volgens de syntax van UriParameter

noord-holland; groningen; etc.

UriParameter

Naam van het geo-object dat gebruikt kan worden in een zoekopdracht

s-gravenhage; utrecht; etc.

 

2.2       Plaatsvarianten

Om plaatsnamen die incorrect getypt zijn (zoals sGravenhage i.p.v. ‘s Gravenhage) of plaatsnamen waarbij er meerdere verbasteringen bestaan naast de officiële plaatsnaam (zoals ‘Den Haag’); kan gebruikt worden van de plaatsvarianten methode binnen de geo api. Deze methode geeft van een plaatsvariant, de juiste term om te gebruiken binnen een zoekopdracht.

Voorbeeld van een aanroep

/feeds/Zoektermen.svc/geo/XXXXXX/plaatsvariant/

Deze aanroep retourneert alle plaatsvarianten in de funda database. Deze lijst wordt ook gebruikt op de funda websites.

Response

Er wordt een bericht teruggestuurd welke voldoet aan het volgende contract:

<feed xmlns="http://funda.nl/api/zoektermen/2009-03-16" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">

       <Objects>

             <Object>

                    <Description> </Description>

                    <Parent> </Parent>

                    <UriParameter> </UriParameter>

             </Object>

       </Objects>

</feed>

Naam

Beschrijving

Mogelijke waardes

Description

Manier waarop de plaatsvariant wordt gespeld, met als eerste teken een hoofdletter

Zaandma; Den Haag; etc.

Parent

De naam van het juist gespelde object

Zaandam; ’s Gravenhage; etc.

UriParameter

Naam van de parent, zoals deze gebruikt kan worden in een zoekopdracht

zaandam; s-gravenhage; etc.

 

!         Gebruik eerst de geo-api om te zoeken naar plaatsen met een bepaalde naam. Mocht de plaats niet te vinden zijn, gebruik dan de plaatsvarianten api, voordat er een foutmelding wordt weergegeven.


 

Bijlage 1. Toegestane zoekopdracht-indicatoren

!         Niet elke indicator is toegestaan voor elk soort aanbod. Dit wijst zich meestal vanzelf.

<

0-4m-frontbreedte

4-6m-frontbreedte

6-8m-frontbreedte

8+m-frontbreedte

aanvullende-horeca

cafe-bar

cafetaria

casco-horecaruimte

dagexploitatie

discotheek-dancing

eetcafe

hotel

restaurant

wegrestaurant

zalen-partycentrum

aan-vaarwater

bedrijventerrein

elders

overheaddeuren

gdv

loading-docks

horeca-concentratie-gebied

havengebied

industrieterrein

kantorenpark

pdv

stadskern

winkelcentrum

woonomgeving

stationslokatie

stadscentrum-dorpskern

beleggingsobject

veilingsobject

per-direct

woonruimte

turnkey

te-openen-ramen

airconditioning

sorteer-regio

sorteer-naam

inbeeld

0-50m2-terreinopp

50+m2-terreinopp

100+m2-terreinopp

250+m2-terreinopp

500+m2-terreinopp

1000+m2-terreinopp

2500+m2-terreinopp

5000+m2-terreinopp

0-50m2-verkoopopp

50+m2-verkoopopp

100+m2-verkoopopp

250+m2-verkoopopp

500+m2-verkoopopp

750+m2-verkoopopp

1000+m2-verkoopopp

2500+m2-verkoopopp

tuin

garage

cv-ketel

stoomcabine

jacuzzi

bedrijfsruimte

met-elektrische-deur

direct

gestoffeerd

gemeubileerd

permanent-bewoonbaar

1+autos

2+autos

3+autos

4+autos

balkon-dakterras

schuur-berging

parkeergelegenheid

time-sharing

360-fotos

brochure

open-huis

slideshow

video

plattegronden

voorzien-van-elektra

voorzien-van-verwarming

met-vliering

voorzien-van-water

lift

aan-bosrand

beschutte-ligging

buiten-bebouwde-kom

in-centrum

aan-drukke-weg

aan-park

aan-rustige-weg

vrij-uitzicht

aan-water

in-woonwijk

open-haard

open-ligging

bouwrijp

niet-bouwrijp

zwembad

bouwperiode-voor-1906

bouwperiode-voor-1906

bouwperiode-1906-1930

bouwperiode-1931-1944

bouwperiode-1945-1959

bouwperiode-1960-1970

bouwperiode-1971-1980

bouwperiode-1981-1990

bouwperiode-1991-2000

bouwperiode-na-2000

woonhuis

appartement

bouwgrond

parkeergelegenheid

overige

vrijstaande-woning

geschakelde-2-onder-1-kapwoning

geschakelde-woning

2-onder-1-kapwoning

hoekwoning

tussenwoning

eindwoning

halfvrijstaande-woning

beneden-en-bovenwoning

benedenwoning

bovenwoning

galerijflat

maisonnette

penthouse

portiekflat

portiekwoning

garagebox

inpandige-garage

parkeerkelder

parkeerplaats

berging

ligplaats

stacaravanstandplaats

woonwagenstandplaats

1-dag

3-dagen

5-dagen

10-dagen

1+kamers

2+kamers

3+kamers

4+kamers

5+kamers

winkel,kantoor,horeca,bouwgrond,bedrijfshal,overig

europe

Projectnaam

nieuwbouw

recreatie

publicatiedatum-na

wintersport-locatie

vlakbij-strand

rustieke-omgeving

vlakbij-golfbaan

100-200-opp

1000-1500-opp

1500-3000-opp

200-300-opp

300-400-opp

3000-5000-opp

400-500-opp

0-50-opp

50-100-opp

500-750-opp

5000-7500-opp

750-1000-opp

7500+opp

nevenbestemming-kantoor

nevenbestemming-bedrijfshal

nevenbestemming-winkel

nevenbestemming-horeca

nevenbestemming-bouwgrond

bungalow

eengezinswoning

grachtenpand

herenhuis

landgoed

landhuis

stacaravan

villa

woonboerderij

woonboot

woonwagen

type-appartement

bel-etage

corridorflat

dubbel-bovenhuis

service-flat

souterrain

verzorgingsflat

bestaande-bouw

nieuwbouw

0-250-perceelopp

250+perceelopp

500+perceelopp

1000+perceelopp

2500+perceelopp

5000+perceelopp

0-250-perceelopp

250+perceelopp

500+perceelopp

1000+perceelopp

2500+perceelopp

5000+perceelopp

0-50-woonopp

50+woonopp

75+woonopp

100+woonopp

150+woonopp

250+woonopp

0-50-woonopp

50+woonopp

75+woonopp

100+woonopp

150+woonopp

250+woonopp

+1km

+5km

+10km

+15km

1-5-parkeerplaatsen

5-10-parkeerplaatsen

10-20-parkeerplaatsen

20-50-parkeerplaatsen

50+parkeerplaatsen

0-400cm-hoogte-hal

400-600cm-hoogte-hal

600-800cm-hoogte-hal

800+cm-hoogte-hal

0-1000kg

1000+kg

1500+kg

2000+kg

4000+kg

0-4m-vrije-overspanning

4-8m-vrije-overspanning

8-12m-vrije-overspanning

12+m-vrije-overspanning

0-50m2-kantooropp

50+m2-kantooropp

100+m2-kantooropp

250+m2-kantooropp

500+m2-kantooropp

1000+m2-kantooropp

2500+m2-kantooropp

5000+m2-kantooropp

garagebox

praktijkruimte

showroom

bouw-gestart

bouw-binnen-3-maanden

bouw-binnen-6-maanden

bouw-binnen-1-jaar

bouw-binnen-2-jaar

reeds-ged-opgeleverd

oplevering-binnen-3-maanden

oplevering-binnen-6-maanden

oplevering-binnen-1-jaar

oplevering-binnen-2-jaar

 



[1] Een lijst met alle toegestane indicatoren is te vinden in bijlage 1

[2] Gebruik deze enkel voor het sorteren op koopprijs, en niet voor het tonen van de prijs. Dit veld biedt geen informatie over de voorwaarden, prijsranges, of huurprijzen.