---
title: "Capture_Interactive_Find"
method: GET
path: "/Capture/Interactive/Find/v1.20/json6.ws"
tags: ["Capture_Interactive_Find"]
---

# Capture_Interactive_Find

`GET /Capture/Interactive/Find/v1.20/json6.ws`

Uses a text search to find addresses and places. 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.

## Query parameters

- `Key` string, required
- `Text` string, required
- `Container` string
- `IsMiddleware` boolean
- `Origin` string
- `Countries` string
- `Limit` integer
- `Language` string
- `Bias` boolean
- `Filters` string
- `Type` string

## Response `200`

Success

- Response
  - `Items` object[]
    - `Id` string — The unique Id of the returned address (or Container - for further results) as generated by Capture (note that this Id can change over time).
    - `Type` string — The 'type' of the returned Id. The possible values are Address | Container | Postcode | Street | BuildingName | Building. If the `Type` is 'Address' then the Id can be passed to the Retrieve service. Any other Id should be passed as the Container to a further Find request to get more results.
    - `Text` string — The first half of the address that's displayed to the user. For example, if the returned address is '123 High Street Nairn IV12 4DB United Kingdom' then `Text` will display '123 High Street'.
    - `Highlight` string — A list of number ranges showing which characters in the `Text` and `Description` fields match the user's search term. This can be used to determine which characters should be highlighted in bold in the search field, to give the user a visual representation of what's being searched. If a Container Id is included in the Find request, `Highlight` will be empty. It will be populated for any other request. See [here](/api-reference/address-capture/highlight) for further details.
    - `Description` string — The second half of the address that's displayed to the user, including the number of addresses if the search returns a Container. For example, if a search for the postcode 'IV12 4DB' returns a Container of 125 addresses all on 'High Street', then `Description` would display 'Nairn IV12 4DB United Kingdom - 125 Addresses'.

## Other responses

- `400` — BadRequest
- `401` — Unauthorized
- `403` — Forbidden
- `500` — InternalServerError

---

[API](https://skmtc.dev/loqate/apis/capture-interactive-find.md) · [All operations](https://skmtc.dev/loqate/apis/capture-interactive-find/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/loqate/capture-interactive-find/revisions/0600cbed8444/schema)