wozapi
v1.0.2
Published
WOZ-waarde, BAG-adresgegevens en kadastrale percelen van elk Nederlands adres via 1 endpoint. Client voor woz-api.nl.
Maintainers
Readme
wozapi (Node.js en TypeScript)
Client voor de WOZ API van woz-api.nl: de WOZ-waarde, BAG-adresgegevens en kadastrale percelen van elk Nederlands adres in 1 JSON-response. Geen afhankelijkheden, gebruikt de ingebouwde fetch van Node 18 en hoger. Typedefinities meegeleverd.
Installeren
npm install wozapiGebruik
import { WozApi, WozApiError } from 'wozapi';
const client = new WozApi('jouw-api-key');
try {
const adres = await client.adres('Spuistraat 36C, 1012 TT Amsterdam');
for (const woz of adres.woz) {
console.log(woz.peildatum, woz.vastgesteldeWaarde);
}
} catch (fout) {
if (fout instanceof WozApiError) console.error(fout.status, fout.bericht);
else throw fout;
}Perceelgrenzen als GeoJSON meesturen:
const adres = await client.adres('Spuistraat 36C, 1012 TT Amsterdam', { geometrie: true });Zoeken op BAG-identificatie:
await client.nummeraanduiding('0363200000218908');
await client.adresseerbaarObject('0363010000740855');Creditsaldo opvragen:
console.log(await client.credits());Wat kost het
Een gratis account geeft 10 credits. 1 credit is 1 uniek adres, en hetzelfde adres binnen 7 dagen opnieuw opvragen kost geen extra credit. De prijs per credit begint bij EUR 0,35 excl. btw; zie de prijzen.
Documentatie
- API-referentie: woz-api.nl/swagger
- Uitleg en achtergrond: woz-api.nl/artikelen
- WOZ-waarden per regio: woz-api.nl/woz-waarde-ontwikkeling
Licentie
MIT
Wat het kost
EUR 0,59 per credit bij 100 credits, aflopend tot EUR 0,35 bij 1.000 credits, excl. btw. Geen abonnement en geen minimale afname, dus een maand zonder opvragingen kost niets. 1 credit is 1 uniek adres; hetzelfde adres binnen 7 dagen opnieuw opvragen kost geen extra credit. Een gratis account geeft 10 credits. De staffel staat op woz-api.nl/woz-api-prijs.
