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

---

Jump Straight In

const { Client, lookupPostcode } = require("@ideal-postcodes/core-node");

const client = new Client({ api_key: "iddqd" });

const addresses = await lookupPostcode({ client, postcode: "SW1A 2AA"});

addresses.forEach(a => console.log(`${a.line_1}, ${a.line_2}, ${a.post_town}`));

addresses;
        

See the JavaScript Client documentation