As of September 2019, we've released a modern a revamped javascript client at @ideal-postcodes/core-browser. Documentation for the legacy client ideal-postcodes-core can be found here.
This library provides a core set of API's to interact with the Ideal Postcodes API on the browser.
You may accomplish the following jobs using this library:
- Query addresses for a postcode
- Query for an address with an address fragment
- Autocomplete an address
- Lookup an address by ID
- Check key useability
This library is tested across modern desktop and mobile browers
Internet Explorer 9 and above is supported. Internet Explorer 6, 7 and 8 are not supported
Please see our documentation
You may install it via npm with,
npm install ideal-postcodes-core --saveYou may also use Bower with,
bower install ideal-postcodes-core --saveFinally you can install it manually by copying the minified build from /dist/
Run the test suite with,
gulp testYou may test the library manually in a browser console with,
gulp webserverMIT