Fork me on Github

UK Postcode & Address API
for Developers


Sign up for a Free Trial

Latest from the Blog: Why we use SSL for everything

Simply Lookup UK Postcodes

 1curl https://api.ideal-postcodes.co.uk/v1/postcodes/ID11QD?api_key=ak_Iddqd8Idkfa7Idchoppers8
 2
 3# {
 4#   "result": [
 5#     {
 6#       "postcode": "ID1 1QD",
 7#       "post_town": "LONDON",
 8#       "line_1": "Kingsley Hall",
 9#       "line_2": "Powis Road",
10#       "line_3": "",
11#       "organisation_name": "",
12#        ...
 1require 'ideal_postcodes'
 2IdealPostcodes.api_key = "ak_Iddqd8Idkfa7Idchoppers8"
 3postcode = IdealPostcodes::Postcode.lookup "ID1 1QD"
 4
 5# postcode.addresses
 6#
 7# [{
 8#  :postcode => "ID1 1QD",
 9#  :post_town => "LONDON",
10#  :line_1 => "Kingsley Hall",
11#  :line_2 => "Powis Road",
12#  :line_3 => "",
13#  :organisation_name => "",
14#  ...

Github: Ideal Postcodes Ruby Wrapper

 1var api_key = "ak_Iddqd8Idkfa7Idchoppers8",
 2    idealPostcodes = require('ideal-postcodes')(api_key);
 3
 4idealPostcodes.lookupPostcode("ID1 1QD", function (error, addresses) {
 5  console.log(addresses);
 6});
 7
 8// [
 9//  {
10//    postcode : "ID1 1QD",
11//    post_town : "LONDON",
12//    line_1 : "Kingsley Hall",
13//    line_2 : "Powis Road",
14//    line_3 : "",
15//    organisation_name : "",
16//   ...

Github: Ideal Postcodes Node.js Wrapper

 1import httplib, urllib, json
 2
 3postcode = "ID1 1QD"
 4params = {"api_key": "ak_Iddqd8Idkfa7Idchoppers8"}
 5
 6conn = httplib.HTTPSConnection("api.ideal-postcodes.co.uk:443")
 7conn.request("GET", "/v1/postcodes/%s?%s" % (urllib.quote(postcode), urllib.urlencode(params)))
 8
 9addresses = json.load(conn.getresponse())['result']
 1<?php
 2$postcode = "ID1 1QD";
 3$api_key  = "ak_Iddqd8Idkfa7Idchoppers8";
 4$base_url = "https://api.ideal-postcodes.co.uk/v1/postcodes/";
 5$url      = $base_url . rawurlencode($postcode) . "?api_key=" . $api_key;
 6$ch       = curl_init();
 7curl_setopt($ch, CURLOPT_URL, $url);
 8curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
 9$response = json_decode(curl_exec($ch), true);
10curl_close($ch);
11$addresses = $response["result"];
12?>
 1String apiKey = "ak_Iddqd8Idkfa7Idchoppers8";
 2String postcode = "ID11QD";
 3String baseUrl = "https://api.ideal-postcodes.co.uk/v1/postcodes/";
 4
 5URL obj = new URL(baseUrl + postcode + "?api_key=" + apiKey);
 6
 7HttpsURLConnection con = (HttpsURLConnection) obj.openConnection();
 8
 9con.setRequestMethod("GET");
10
11int responseCode = con.getResponseCode();
12
13BufferedReader in = new BufferedReader(
14        new InputStreamReader(con.getInputStream()));
15String inputLine;
16StringBuffer response = new StringBuffer();
17
18while ((inputLine = in.readLine()) != null) {
19  response.append(inputLine);
20}
21in.close();
22
23// Use your favourite JSON parser to handle response

Postcode Lookups in Moments with jQuery

  • Embed our jQuery Plugin on any page and configure. Try our live example demo below...
<script>
// Add this after your form
$.idealPostcodes.setup({
  // Add your API key
  api_key: 'ak_hk71kco54zGSgVf9ExxRVVNmolLNh',
  // Identify your fields with CSS selectors
  output_fields: {
    line_1: '#first_line',  
    line_2: '#second_line',         
    line_3: '#third_line',
    post_town: '#post_town',
    postcode: '#postcode'
  }
});

$('#lookup_field').setupPostcodeLookup();
</script>
<!-- Add a div to house your 
     postcode input field -->
<div id="lookup_field"></div>

<!-- This is your existing form -->
<label>Address Line One</label>
<input id="first_line" type="text">

<label>Address Line Two</label>
<input id="second_line" type="text">

<label>Address Line Three</label>
<input id="third_line" type="text">

<label>Post Town</label>
<input id="post_town" type="text">

<label>Postcode</label>
<input id="postcode" type="text">

For the purposes of this demo, we provide 15 postcode lookups per day