JavaScript (browser) client for api.ideal-postcodes.co.uk
@ideal-postcodes/core-browser is the JavaScript browser client for api.ideal-postcodes.co.uk
Our JavaScript client implements a common interface defined at @ideal-postcodes/core-interface.
High level client documentation can be found at core-interface.
In depth client documentation can be found at core-interface.ideal-postcodes.co.uk.
Tested against a suite of modern and legacy, mobile and desktop browsers.
@ideal-postcodes/core-browsershould be consumed by a bundler or transpiler (e.g. webpack, parcel, rollup) for minification, module resolution and specific browser support.
core-browser-bundled provides pre-bundled versions of core-browser, which can be immediately dropped into a page.
- Configuration & Usage
- Quickstart
- Client Documentation
- In Depth Client Documentation
- npm Module
- GitHub Repository
- Install
- Instantiate and Use client
- Catch Errors
npm install @ideal-postcodes/core-browserimport{Client}from"@ideal-postcodes/core-browser";constclient=newClient({api_key: "iddqd"});constaddresses=awaitlookupPostcode({client: client,postcode: "SW1A2AA"});import{errors}from"@ideal-postcodes/core-browser";const{ IdpcRequestFailedError }=errors;try{awaitlookupAddress({ client,query: "10 downing street"});}catch(error){if(errorinstanceofIdpcRequestFailedError){// IdpcRequestFailedError indicates a 402 response code// Possibly the key balance has been depleted}}core-browser uses the Fetch API under the hood to facilitate HTTP requests.
A configuration object can be passed to the Client constructor as a second argument to override certain attributes on the Request of all subsequent fetch requests. Request configuration is documented here.
If you need to support older browsers, please include a fetch polyfill and transpile this library down to ES3. Alternatively use one of our pre-transpiled outputs at ideal-postcodes/core-browser-bundled.
The client exposes a number of simple methods to get at the most common tasks when interacting with the API. Below is a (incomplete) list of commonly used methods.
For a complete list of client methods, including low level resource methods, please see the core-interface documentation
Return addresses associated with a given postcode
constpostcode="id11qd";constaddresses=awaitlookupPostcode({ client, postcode });Return addresses associated with a given query
constquery="10 downing street sw1a";constaddresses=awaitlookupAddress({ client, query });Return address for a given udprn
Invalid UDPRN will return null
constudprn=23747771;constaddress=awaitlookupUdprn({ client, udprn });npm testMIT