Skip to main content
GET
Autocomplete Places

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

q
string
required

Free-text query to autocomplete (Brazil)

Example:

"avenida paulista"

sessionToken
string

Client-generated UUID grouping autocomplete + details

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Place autocomplete result

suggestions
object[]
required

Place suggestions