Skip to main content

​
Visão geral

Retorna sugestões de lugares baseado em uma entrada de texto parcial. É útil para implementar campos de busca com autocompletar.

​
Endpoint

GET /api/maps/autocomplete

​
Parâmetros de Query

ParâmetroTipoObrigatórioDescrição
inputstringSimTexto de busca parcial

​
Exemplo de Requisição

curl -H "X-API-Key: sua_chave_aqui" \
  "https://api.fretamaps.com.br/api/places/autocomplete?input=São Paulo"

​
Exemplo de Resposta

{
  "predictions": [
    {
      "id": "ChIJ0WGkg4FEzpQRrlsz_whLqZs",
      "description": "São Paulo, SP, Brasil"
    },
    {
      "id": "ChIJd8BlQ2BZwokRAFUEcm_qrcA",
      "description": "São Paulo, Estado de São Paulo, Brasil"
    }
  ],
  "source": "Google"
}

​
Estrutura de Resposta

​
predictions
array
required
Array de previsões de lugares
​
predictions[].id
string
required
Identificador único do lugar (place_id)
​
predictions[].description
string
required
Descrição formatada do lugar
​
source
string
required
Fonte dos dados: "Google", "Here" ou "Cache"

​
Headers de Resposta

  • X-Cache: HIT se veio do cache, MISS se foi buscado da API
  • X-Provider: Google ou Here
  • X-Format: Standard

​
Códigos de Status

  • 200 OK - Requisição bem-sucedida
  • 400 Bad Request - Parâmetro input não fornecido
  • 401 Unauthorized - Autenticação falhou
  • 500 Internal Server Error - Erro ao buscar dados do provedor

​
Notas

  • O cache é verificado primeiro. Se houver resultado em cache válido, ele será retornado imediatamente.
  • Os resultados são limitados a 5 sugestões por padrão.
  • A busca é otimizada para o Brasil (country:br).