---
title: "Address suggestions for what has been typed into Street address"
method: GET
path: "/address-suggestions"
tags: ["Users"]
---

# Address suggestions for what has been typed into Street address

`GET /address-suggestions`

## Request

- Base URL: `https://whatareyoudo.ing/api/v1`
- URL: `https://whatareyoudo.ing/api/v1/address-suggestions`
- Auth: HTTP bearer

Relays Google Places Autocomplete (New); the key stays on the server. At most five street addresses, premises or roads -- no businesses or cities -- in `lang` (one of the app's fifteen, English otherwise), and only inside `region` when it is given. `sessionToken` is the client's, minted when typing starts and sent again on the details call for the suggestion picked, so Google bills the whole lookup as one session. With `kind=place` (the entry editor's "Find on map") nothing is narrowed by type: businesses, stations and landmarks are offered too. With both `nearLat` and `nearLng` (#1711), places within about 20 km of that position are preferred, without excluding the rest. Limited per user (120 an hour).

## Query parameters

- `input` string, required
- `sessionToken` string, required
- `lang` string
- `region` string
- `kind` 'address' | 'place'
- `nearLat` number, nullable
- `nearLng` number, nullable

## Response `200`

OK

- object
  - `data` AddressSuggestion[], required
    - `placeId` string, required
    - `mainText` string, required
    - `secondaryText` string, required
  - `meta` object, required
    - `requestId` string, required

## Other responses

- `429`: Over the per-user limit; Retry-After says when to ask again
- `503`: Address suggestions are not configured, or Google did not answer

---

[API](https://skmtc.dev/whatareyoudo/apis/whatcha-api.md) · [All operations](https://skmtc.dev/whatareyoudo/apis/whatcha-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whatareyoudo/apis/whatcha-api/revisions/48dd8a54abea?raw)