Skip to main content

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 .


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.

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"

Live Demo