GET v3/addresses?postcode={postcode}
Returns a list of addresses matching a given postcode. (UK Addresses only)
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| postcode |
The postcode to use |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of summarised addresses with associated IDs
Collection of PostcodeLookupResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Description |
A summary of the address |
string |
None. |
| Id |
The postcode lookup id for the address. Use this to get the full address. |
string |
None. |
Response Formats
application/json, text/xml
Sample:
Sample not available.