GET /v1/suggest

Trả về tối đa 7 kết quả gợi ý khớp với đoạn văn bản đầu vào.

Scope yêu cầu: geocoding:read

Request

GET /v1/suggest?input=ho+chi
X-API-Key: gdk_live_xxxxxxxxxxxxxxxxxxxxxxxx

curl -G "https://api.gogoduk.com/v1/suggest" \
-H "X-API-Key: $GOGODUK_API_KEY" \
--data-urlencode "input=ho chi" \
--data-urlencode "lang=vi"

Query parameters

Name	Bắt buộc	Mô tả
`input`	có	Văn bản tìm kiếm. Tối thiểu 2 ký tự.
`lang`	không	Mã ngôn ngữ. Hỗ trợ: `vi` (mặc định), `en`. Giá trị khác trả về `400`.
`country`	không	Bộ lọc quốc gia. Chỉ hỗ trợ `VN` (hoặc `VNM`). Giá trị khác trả về `400`.
`sessionToken`	không	Gộp các lần gõ phím autocomplete thành một session tính phí duy nhất. Bạn cũng có thể truyền qua header `X-Session-Token` nếu muốn.
`focus.lat`	không	Ưu tiên các gợi ý gần với latitude này.
`focus.lon`	không	Ưu tiên các gợi ý gần với longitude này.

Response

{
  "predictions": [
    {
      "placeId": "ChIJi85p5P0ldTERfqSM08G0C1Q",
      "text": "201 Trần Não, Khu phố 3, An Khánh, Thủ Đức, Thành phố Hồ Chí Minh",
      "mainText": "201 Trần Não",
      "secondaryText": "Khu phố 3, An Khánh, Thủ Đức, Thành phố Hồ Chí Minh",
      "types": ["geocode", "subpremise"]
    }
  ]
}

Response fields

Field	Type	Mô tả
`predictions[].placeId`	string	Định danh ổn định. Truyền vào `/v1/place/resolve`.
`predictions[].text`	string	Địa chỉ đầy đủ đã được định dạng.
`predictions[].mainText`	string	Dòng chính (ví dụ: số nhà + tên đường, tên POI).
`predictions[].secondaryText`	string	Dòng phụ (phân cấp hành chính).
`predictions[].types`	string[]	Các loại địa điểm theo kiểu Google, tùy chọn.

Common errors

400 BAD_REQUEST — input ngắn hơn 2 ký tự.
401 INVALID_API_KEY — không nhận diện được key.
403 INSUFFICIENT_SCOPE — key thiếu scope geocoding:read.
429 RATE_LIMIT_MINUTE — chờ rồi thử lại theo giá trị field retry_after.

GET /v1/suggest

Request

Query parameters

Response

Response fields

Common errors

On this page