PostCode.nl REST Client

A rest client for the postcode.nl api.

Author

Jurien Hamaker

Issues

If you encounter any issues using this package, please report them at the issues tab of the github repository

Usage

All functionalities are based off of the Postcode.nl documentation for their rest api.

Installation

Run the following to add it to your project; npm install --save postcodenl

Usage

Initialization

let postcodenl = require('postcodenl');
let postCodeNLClient = new postcodenl(key, secret);

All functionalities are named as in the documentation and with their respective responses.

viewByPostcode

viewByPostcode(postcode:string,houseNumber:string[,houseNumberAddition:string]);

postCodeNLClient.viewByPostcode(postcode, housenumber)
.then(result => console.log)
.catch(err => console.log);

matchExact

matchExact(city:string,street:string,houseNumber:string[,houseNumberAddition:string]);

postCodeNLClient.matchExact(city, street, houseNumber)
.then(result => console.log)
.catch(err => console.log);

viewByRd

viewByRd(rdX:Number,rdY:Number);

postCodeNLClient.viewByRd(rdX, rdy)
.then(result => console.log)
.catch(err => console.log);

viewByLatLon

viewByLatLon(latitude:Number,longitude:Number);

postCodeNLClient.viewByLatLon(latitude, longitude)
.then(result => console.log)
.catch(err => console.log);

postcodeRanges

This is the only call with deviant naming, because this uses the same name as "viewByPostcode" but has a different namespace within the postcodenl api.

postcodeRanges(postcode:string);

postCodeNLClient.postcodeRanges(postcode)
.then(result => console.log)
.catch(err => console.log);