Skip to main content
GET
Autocomplete place search

Authorizations

x-api-key
string
header
required

Your Footstep API key

Query Parameters

text
string
required

Partial text input for typeahead suggestions

size
integer
default:10

Maximum number of results

Required range: 1 <= x <= 40
focus.point.lat
number

Latitude to bias results toward. Supply whenever you have spatial context — user's current location, map viewport, last-known anchor. Same-name places nearby float above distant namesakes. Pair with focus.point.lon.

Required range: -90 <= x <= 90
focus.point.lon
number

Longitude to bias results toward. Pair with focus.point.lat.

Required range: -180 <= x <= 180
boundary.country
string

Comma-separated ISO 3166-1 alpha-3 country codes to restrict results (e.g. 'GBR' or 'GBR,USA'). Set when the search context is country-bound.

place_types
string

Comma-separated place types to filter: venue, address, street, locality, region, country

Response

Autocomplete suggestions

results
object[]
required
query
object
required