node-postcode-nl

Node module to obtain Dutch postcodes via postcodeapi.nu. The module is able to perform requests to the v2 API, does some basic validation before the call is performed, handles errors from the API and returns the results as a json for further processing within your own application. To use this module, requesting an API-key at postcodeapi.nu is required.

Using the module

Simply grap the module from npm by doing npm install --save postcode-nl. After that you can include it in your application with require('postcode-nl').

Methods

This module exposes various methods globally, as a callback function or as a promise:

- getSingleAddress - To search for an address based on the BAG identifier of the object.
- getSinglePostcode - Returns the details of a single P6 postcode.
- getAddresses - Returns a list of addresses, it is possible to filter on postcode (P6-formatted) and number.
- getAddressesByPostcodeAndNumber - Returns a list of addresses filtered on postcode (P6-formatted) and number. The difference with getAddresses is that filtering is required, otherwise an error is thrown.
- getPostcodes - Returns a list of postcodes (P6), optionally filtered on postcode area.
- helpers - Some additional helper functions to validate postcodes and handling HAL-responses from the API.

The documentation contains a full explaination of all the parameters and provide some examples. The documentation could be accessed by web or could be build from source by using jsdoc.

Issues or feature requests

If you encounter any issue with this module, please fill in a bug report at this repository. Over there you can also report feature requests. If you encounter issues with the web-API itself, please head over to the repository of Apiwise.

Contributing

You are always welcome to contribute to this project by purposing a PR. Please document your code thoroughly: document new methods using the jsdoc notation and use inline comments to clarify what you are doing. Please check your code with eslinter and the ruleset defined in this repository before you submit it, to ensure you are using a consistent coding style.

Compatibility

The module is tested against the LTS and current versions of Node.js, currently the 18.x, 20.x and 21.x branches. It may work with other versions of Node.js, however it is not supported.

License

Copyright (c) 2019-2024 Joost de Bruijn and contributors

The module is licensed under the MIT License.