Bem-vindo à documentação da API Loccalize! Este guia irá ajudá-lo a integrar rapidamente nossos serviços de geolocalização em sua aplicação.
O Loccalize oferece endpoints poderosos para busca de locais, geocodificação e geocodificação reversa. Nossa API é RESTful, retorna dados em JSON e suporta CORS para uso em aplicações web.
Respostas em menos de 100ms
Autenticação por API Key
Até 1M requisições/mês
Todas as requisições devem incluir sua API Key. Você pode autenticar de duas formas:
⚠️ Importante: Mantenha sua API Key segura e nunca a exponha em código client-side.
Aplicamos limites de taxa para garantir a qualidade do serviço. Os limites variam por plano:
| Plano | Requisições/Minuto | Requisições/Mês | Preço |
|---|---|---|---|
| Starter | 5.000 | 10.000 | R$ 79/mês |
| PRO⭐ Mais Popular | 20.000 | 200.000 | R$ 899/mês |
| Enterprise | 50.000 | 500.000 | R$ 1.199/mês |
| Consulte | Ilimitado | Ilimitado | Sob consulta |
💡 Dica: As respostas incluem headers informativos sobre seus limites:X-RateLimit-Remaining eX-RateLimit-Reset
Busca locais próximos a uma coordenada
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| lat | number | Sim | Latitude (-90 a 90) |
| lng | number | Sim | Longitude (-180 a 180) |
| radius | number | Não | Raio em metros (padrão: 1000, máx: 50000) |
| limit | number | Não | Limite de resultados (padrão: 10, máx: 100) |
Busca locais por nome ou categoria
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| q | string | Sim | Termo de busca (nome ou categoria) |
| lat | number | Não | Latitude para ordenar por proximidade |
| lng | number | Não | Longitude para ordenar por proximidade |
| limit | number | Não | Limite de resultados (padrão: 10, máx: 100) |
Converte endereço em coordenadas
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| address | string | Sim | Endereço para geocodificar |
| country | string | Não | Código do país (ISO 3166-1 alpha-2) |
Converte coordenadas em endereço
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| lat | number | Sim | Latitude (-90 a 90) |
| lng | number | Sim | Longitude (-180 a 180) |
Geocodifica múltiplos endereços em uma única requisição
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| addresses | array | Sim | Array de endereços para geocodificar (máximo 100) |
Autocompletar endereços brasileiros em tempo real
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| q | string | Sim | Termo de busca para autocompletar (mínimo 2 caracteres) |
| limit | number | Não | Limite de resultados (padrão: 5, máx: 10) |
Busca locais próximos a uma coordenada
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| lat | number | Sim | Latitude (-90 a 90) |
| lng | number | Sim | Longitude (-180 a 180) |
| radius | number | Não | Raio em metros (padrão: 1000, máx: 50000) |
| limit | number | Não | Limite de resultados (padrão: 10, máx: 100) |
A API retorna códigos de status HTTP padrão e mensagens de erro detalhadas:
| Código | Descrição | Causa Comum |
|---|---|---|
| 200 | OK | Requisição bem-sucedida |
| 400 | Bad Request | Parâmetros inválidos ou ausentes |
| 401 | Unauthorized | API Key inválida ou ausente |
| 429 | Too Many Requests | Limite de taxa excedido |
| 500 | Internal Server Error | Erro interno do servidor |
Estamos trabalhando em SDKs oficiais para facilitar a integração:
SDK oficial em desenvolvimento
Em breveSDK oficial em desenvolvimento
Em breveSDK oficial em desenvolvimento
Em breve📧 Quer ser notificado quando os SDKs estiverem prontos?Entre em contato conosco
Precisa de ajuda? Estamos aqui para você:
suporte@loccalize.com
Resposta em até 24h