TIC
POSThttps://lens-api.tic.io/search-autocomplete/addresses

Authorization

x-api-keystringheaderrequired

Your API key, sent in the x-api-key header.

Bodyapplication/json

qstring | null
pageinteger

format: int32 · >= 1 · <= 2147483647

per_pageinteger | null

format: int32

Responses

Slim autocomplete response · application/json

foundinteger

format: int32

pageinteger

format: int32

outOfinteger

format: int32

searchTimeMsinteger

format: int32

hitsAddressAutocomplete_Dto[] | null
Hide child attributes
idstring | null
addressIdinteger | null

format: int32

addressUuidstring | null
propertyIdinteger | null

format: int32

propertyUuidstring | null
fullAddressstring | null
streetNamestring | null
streetNumberstring | null
postalCodeinteger | null

format: int32

citystring | null
municipalityCodeinteger | null

format: int32

municipalityNamestring | null
districtCodestring | null
districtNamestring | null
positionnumber[] | null
addressTypestring

One of: gatuadressomrade metertalsadressomrade byadressomrade

buildingAreainteger | null

format: int32

livingAreainteger | null

format: int32

How the query is matched

The request carries only q, page and per_page. Everything else is fixed by the API, which searches the addresses_se collection as below.

Field searchedTypeDescription
fullAddress
q
Optional; leaving it out searches with * and returns the first hits of the collection.
per_page
1 to 10; omitted means 10, more is answered with 400.
The last word is a prefix
While someone types, the word under the cursor matches the start of a word: "volv" finds Volvo. Earlier words match whole.
Typos are forgiven
Words of 4 to 6 characters match with one typo, 7 or more with two. Shorter words must be exact.
Words drop from the end
When no hit contains every word, the last words are dropped until something matches, so a longer query narrows the list without emptying it.
Ranked by text match
Hits come back best match first (_text_match:desc); there is no other sort.

Try the autocomplete

Type as your users would and watch the hits arrive through the proxy, listed the way an integration shows them.

Autocomplete · addresses_se
Authorization

Stored in this browser only (until you forget it) and sent as the x-api-key header through the documentation proxy.

Try

Each pause while typing (300 ms) sends one request, which counts against your API key's quota.

Request
curl -X POST "https://lens-api.tic.io/search-autocomplete/addresses" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "page": 1,
  "per_page": 10
}'
Enter your API key to send.