Custom response code returned by API.
The response codes first 3 digits, reflects the HTTP status. e.g. 2000 would accompany a 200 OK HTTP status.
We do not recommend performing > or < type comparison operations on code even though its type is number. This prohibits us from producing more than 10 response codes per HTTP status.
Human readable success or error message returned by API.
Result or set of results
Address Query Response Body
Response body returned from a successful address query
Note that the address query API will not return a 404 response if no results are found (unlike the postcode lookup API). Instead an empty array is returned.
API Documentation for
addresses?query=: ideal-postcodes.co.uk/documentation/addresses#query.Example Request:
api.ideal-postcodes.co.uk/v1/addresses?q=10 downing street london