Skip to main content
GET
/
Capture
/
Interactive
/
Find
/
v1.20
/
json6.ws
cURL
curl --request GET \
  --url https://api.addressy.com/Capture/Interactive/Find/v1.20/json6.ws
{
  "Items": [
    {
      "Id": "GB|RM|B|55605138|ENG",
      "Type": "Address",
      "Text": "G B G Evermore 128 Queen Victoria Street",
      "Highlight": "0-1,2-3,4-5",
      "Description": "London EC4V 4BJ"
    }
  ]
}
Note this does not return formatted addresses, and repeated calls to this service may be required to drill-down through results until an address ID is returned. The address ID should then be passed into the Retrieve service to obtain a fully formatted address. This method does not consume credit.
We don’t support API connections using HTTP - all calls should use HTTPS.

Query Parameters

​
Key
string
required

The key used to authenticate with the service. For example: 'AA11-AA11-AA11-AA11'.

​
Text
string
required

The search text to find. Ideally the start of the address, or in some countries a postal code.

​
Container
string

A container for the search. This should only be another Id previously returned from this service when the Type of the result was not 'Address'.

​
IsMiddleware
boolean

Whether the API is being called from a middleware implementation (and therefore the calling IP address should not be used for biasing).

​
Origin
string

A starting location for the search. This can be the name or ISO 2 or 3 character code of a country, WGS84 coordinates (comma separated) or IP address to search from.

​
Countries
string

A comma separated list of ISO 2 or 3 character country codes to limit the search within.

​
Limit
integer

The maximum number of results to return. If left blank, this will default to 10.

​
Language
string

The preferred language for results where the same address matches input in different languages. This parameter will also affect the label "Addresses" in the Description field of the Container results, eg. where Language=es, the value will be "direcciones". The value should be a 2 or 4 character language code e.g. (en, fr, en-gb, en-us).

​
Bias
boolean

This setting will enable or disable biasing, which allows Capture to return results that are closer to the end user. See here for more details. This can also be controlled in the account portal.

​
Filters
string

This setting allows filtering of addresses returned by the Find method. Supported filters are described on the Filters page.

​
Type
string

This setting is only applicable if you have OS AddressBase Premium dataset enabled. For usage, check out search type for more details.

Response

Success

​
Items
object[]
⌘I