Skip to main content

Changelog

December 2022​

  • Phone Validation API now generally available.
  • UK post towns are now titlecased (instead of all caps).
  • Republic of Ireland addresses can be retrieved via the /postcodes/:postcode API if Eircode is enabled.

November 2022​

  • Email Validation API now available.
  • Wildcard subdomain allowed URLs available. Add *.domain.com to allow requests from domain.com and all related subdomains.
  • Address Finder search improvements. Better search for numeric property numbers with preceeding zeros. Improved search for address ranges.

October 2022​

  • Allowed URLs now permits subdomain wildcards. E.g. *.example.com will match example.com as well as all subdomains.

August 2022​

  • New Places API
  • /places?query= to query for place suggestions
  • Allow for IP, geolocation and country filtering and biasing
  • places/:id to resolve details for a place given a suggestion

July 2022​

  • /autocomplete/addresses/:id/gbr now returns the local format of an address if not located in GBR inside the native attribute
  • /autocomplete/addresses/:id/usa now returns the local format of an address if not located in USA inside the native attribute

June 2022​

  • Irish Addresses (Eircodes) now supported by the autocomplete API. Contact our support team to have this enabled on your account
  • /addresses API now provides reverse geocoding if lon= and lat= query arguments are supplied. Results are ordered by proximity to the supplied geospatial points

May 2022​

  • UK Alias addresses now generally available
  • /keys/:key API now returns a contexts which correlates with the users locality

April 2022​

  • Welsh PAF addresses now generally available

March 2022​

  • New autocomplete/addresses/:id/usa API which resolves address suggestions to the USA address format

February 2022​

  • Addressing data for USA available
  • /autocomplete/addresses now accepts a context= argument which allows additional countries to be searched. This currently defaults to GBR but also accepts USA
  • New autocomplete/addresses/:id/gbr API which resolves address suggestions to the GBR address format (regardless of country)

January 2022​

  • The standard GBR address objects now also return an id attribute
  • The standard GBR address object now also returns a dataset attribute which identifies the provenenace of a result (e.g. paf means Postcode Address File, mr means Multiple Residence and nyb means Not Yet Built)
  • The standard GBR address object now also returns a country_iso which returns the 3 letter ISO country code

December 2021​

  • /addresses and /autocomplete/addresses now accepts query arguments to bias results by a geospatial area defined by an origin (WGS84 coordinate) and radius (in metres) with bias_lonlat=[longitude],[latitude],[radius]
  • /addresses and /autocomplete/addresses now accepts query arguments to filter results by a geospatial box defined by an "top-left" and "bottom-right" WGS84 coordinates. Filter addresses with box=[top left longitude],[top left latitude],[bottom right longitude],[bottom right latitude]

July 2021​

  • /addresses and /autocomplete/addresses now accepts query arguments to bias results by a geospatial area defined by an origin (WGS84 coordinate) and radius (in metres) with bias_lonlat=[longitude],[latitude],[radius]
  • /addresses and /autocomplete/addresses now accepts query arguments to filter results by a geospatial box defined by an "top-left" and "bottom-right" WGS84 coordinates. Filter addresses with box=[top left longitude],[top left latitude],[bottom right longitude],[bottom right latitude]

June 2021​

  • /addresses and /autocomplete/addresses now accepts query arguments to bias results by locality or postcode elements like post_town or postcode_sector with bias_post_town= and bias_postcode_sector=

May 2021​

  • /postcodes/:postcode now returns up to 5 suggested postcodes if there is no exact postcode match. It will check for common errors first (i.e. mixing up 0 and O or 1 and I).

April 2021​

  • /postcodes/:postcode now returns total, limit and page attributes for all responses (not just Multiple Residence)

March 2021​

  • /keys/:key API now accepts sublicensee keys that begin sl_

February 2021​

January 2021​

  • Usage log exports now reports the Origin header in the URL column if the Referer is not available.

December 2020​

  • Checking key details with the /keys/:key will now return a datasets attribute. This identifies which datasets (i.e. PAF, Multiple Residence, Not Yet Built) this key has access to.

November 2020​

  • Licensee keys may now be passed in via the API Key argument of the querystring (api_key=) or authorisation header IDEALPOSTCODES api_key="". Our documentation will be updated to reflect this as the primary method of identifying a licensee. However the earlier method of supplying both licensee and api_key will continue to be supported.

October 2020​

  • /addresses no accepts no terms query. This means addresses can be searched using just filters like postcode
  • New filters available for /addresses including postcode_area, postcode_sector, uprn and more
  • Search /addresses with UPRNs using the uprn= filter

September 2020​

  • Address responses now return a uprn attribute for GB addresses
  • GB address geolocations are now rooftop accurate if they have a uprn assigned