Skip to main content
GET
/
api
/
v1
/
bko
/
places
/
autocomplete
Autocomplete Places
curl --request GET \
  --url https://api.example.com/api/v1/bko/places/autocomplete \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "placeId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "lat": 123,
      "lng": 123
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 125,
    "totalPages": 7
  }
}

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

data
object[]
required
meta
object
required

Pagination metadata