Documentation
Getting Started
You are just a few steps away from testing and querying for addressing data
-
Sign up and create an API Key
-
Integrate our API with free test methods
-
Purchase lookups when ready to go live
Search Documentation
Stuck?
Talk to a developer at chat.ideal-postcodes.co.uk or email us at support@ideal-postcodes.co.uk
Open Source
Find out our open sourced projects directory at ideal-postcodes.co.uk/open_source
Guides
Reference
Client Libraries & Integrations
How To
- Add Postcode Lookup to a page
- Add Address Autocomplete to a page
- Retrieve a list of addresses for a postcode
- Retrieve a list of addresses for an address query
- Find out the current state of a key
- Retrieve usage history for a key
- Search for a postcode and premise name or number
- Search for an address by UPRN
Jump Straight In
const { Client } = require("@ideal-postcodes/core-node");
const client = new Client({ api_key: "iddqd" });
const addresses = await client.lookupPostcode({ postcode: "SW1A 2AA"});
addresses.forEach(a => console.log(`${a.line_1}, ${a.line_2}, ${a.post_town}`));
addresses;
See the JavaScript Client documentation