Retrieve Additional Data

You can retrieve more data for an address by passing more arguments into outputFields.

The key value should map to an address field described in our standard address schema .

Example

In this example, geolocation, organisation name and the Unique Delivery Point Reference Number is inserted into additional input fields.

This code demonstrates how to integrate the Ideal Postcodes Address Finder to append alternate address data to custom fields. In this example: - uprn maps to the custom field #uprn, allowing the retrieval of the Unique Property Reference Number. - longitude and latitude map to the fields #longitude and #latitude respectively, enabling geolocation data retrieval.

JavaScript

AddressFinder.setup({
  apiKey: "ak_test",
  outputFields: {
      line_1: "#line_1",
      line_2: "#line_2",
      line_3: "#line_3",
      post_town: "#post_town",
      postcode: "#postcode",
      // Assign address element to a field
      uprn: "#uprn",
      // Geolocation
      longitude: "#longitude",
      latitude: "#latitude"
    } 
  });

HTML

<form>
  <label for="line_1">Address First Line</label>
  <input type="text" id="line_1" />
  <label for="line_2">Address Second Line</label>
  <input type="text" id="line_2" />
  <label for="line_3">Address Third Line</label>
  <input type="text" id="line_3" />
  <label for="post_town">Town or City</label>
  <input type="text" id="post_town" />
  <label for="postcode">Postcode</label>
  <input type="text" id="postcode" />
  <!-- Custom Fields -->
  <input type="hidden" id="uprn" />
  <input type="hidden" id="longitude" />
  <input type="hidden" id="latitude" />
</form>

Live Demo

Loading...