Documentação de Produto - PrismaData API

📌 Visão Geral

A PrismaData oferece acesso via API a dados enriquecidos sobre características socioeconômicas e demográficas associadas a coordenadas geográficas ou endereços.

O geocodificador (ou geocoder) é uma ferramenta essencial para conectar dados geográficos (como endereços) e coordenadas do mundo real (latitude e longitude). É usado em negócios para integrar informações de localização a análises, serviços de entrega, marketing ou gestão urbana. Existem dois tipos principais: *geocodificação direta* e *reversa*.

🧪 Exemplos de uso

📍 Geocodificação bem-sucedida

Rua Alagoas, 601, Savassi - Belo Horizonte - MG – 30130-165 --> (-19.932592391967773, -43.93540573120117)

{
    'prismadata__geocoder__cep': '30130-160',
 'prismadata__geocoder__classificao_qualidade_geocodificacao': 'MUITO_ALTA',
 'prismadata__geocoder__endereco_completo': 'RUA ALAGOAS, 601 - SAVASSI, BELO HORIZONTE - MG, 30130-160',
 'prismadata__geocoder__latitude': -19.932592391967773,
 'prismadata__geocoder__localidade': 'SAVASSI',
 'prismadata__geocoder__logradouro': 'RUA ALAGOAS',
 'prismadata__geocoder__longitude': -43.93540573120117,
 'prismadata__geocoder__municipio': 'BELO HORIZONTE',
 'prismadata__geocoder__numero': 601,
 'prismadata__geocoder__score_qualidade_geocodificacao': 100.0,
 'prismadata__geocoder__uf': 'MG'
}

O ponto destacado na imagem é o resultado da conversão do endereço da PrismaData em coordenadas geográficas. Além da Lat/Lng, a API ainda retorna informações separadas que compõem o endereço, bem como uma avaliação da confiança/qualidade em relação ao resultado da geocodificação.

📍 Geocodificação reversa

(-22.98627572993613, -43.208798617447684) --> AVENIDA VIEIRA SOUTO, 516 - IPANEMA, RIO DE JANEIRO - RJ, 22420-008

{
    'prismadata__reverse_geocoder__cep': '22420-008',
 'prismadata__reverse_geocoder__distancia_m': 7.02674626,
 'prismadata__reverse_geocoder__endereco_completo': 'AVENIDA VIEIRA SOUTO, 516 - IPANEMA, RIO DE JANEIRO - RJ, 22420-008',
 'prismadata__reverse_geocoder__latitude_endereco': -22.986234664916992,
 'prismadata__reverse_geocoder__latitude_input': -22.98627572993613,
 'prismadata__reverse_geocoder__localidade': 'IPANEMA',
 'prismadata__reverse_geocoder__logradouro': 'AVENIDA VIEIRA SOUTO',
 'prismadata__reverse_geocoder__longitude_endereco': -43.2088508605957,
 'prismadata__reverse_geocoder__longitude_input': -43.208798617447684,
 'prismadata__reverse_geocoder__municipio': 'RIO DE JANEIRO',
 'prismadata__reverse_geocoder__numero': 516,
 'prismadata__reverse_geocoder__uf': 'RJ'
}

Conforme a imagem, a latitude de entrada (em vermelho) está a pouco mais de 7 metros do endereço Av. Vieira Souto, 516, Rio de Janeiro - RJ (em azul). Assim, foi feita a conversão de uma coordenada de entrada (Lat/Lng) para o endereço mais próximo desta coordenada.

💡 Geocoder

O Geocoder da PrismaData está disponível apenas para o Brasil, isto é, fazemos a geocodificação direta e reversa apenas para endereços e regiões dentro do território brasileiro. Assim, consideramos nossa solução especializada e focada apenas no território nacional.

Vale ressaltar que o geocoder é, frequentemente, um passo inicial para se obter outros dados da PrismaData, como dados de:

Geocoder Direto

📥 Entradas

• cep: CEP (Código de Endereçamento Postal) do endereço a ser geocodificado.
• endereco_completo: o endereço completo formado pela composição de todos os demais campos a ser geocodificado.
• localidade: nome do bairro ou região do endereço a ser geocodificado.
• logradouro: nome do logradouro em que o endereço a ser geocodificado se encontra.
• tipo_logradouro: nome do tipo do logradouro a ser geocodificado. Ex: Rua, Avenida, Travessa, Pça, etc.
• titulo_logradouro: nome do título do logradouro a ser geocodificado. Ex: Dr., Coronel, São, Dona, etc.
• municipio: nome do município em que o endereço a ser geocodificado se encontra.
• numero: número em relação ao logradouro em que o endereço a ser geocodificado se encontra.
• uf: sigla da unidade federativa em que o endereço a ser eocodificado se encontra.

📦 Atributos Retornados

• cep: CEP (Código de Endereçamento Postal) do endereço geocodificado.
• classificacao_qualidade_geocodficacao: Indicativo da qualidade da geocodificação realizada. As opções de retorno são: "MUITO_ALTA", "ALTA", "MEDIA", "BAIXA" e "MUITO_BAIXA".
• endereco_completo: o endereço completo formado pela composição de todos os demais campos
• latitude: latitude do endereço geocodificado.
• localidade: nome do bairro ou região do endereço geocodificado.
• logradouro: nome do logradouro em que o endereço geocodificado se encontra.
• longitude: longitude do endereço geocodificado.
• municipio: nome do município em que o endereço geocodificado se encontra.
• numero: número em relação ao logradouro em que o endereço geocodificado se encontra.
• score_qualidade_geocodficacao: Quantitativo da qualidade da geocodificação realizada. O score varia de 0 a 100, onde valores mais altos indicam uma confiança maior na geocodificação.
• uf: sigla da unidade federativa em que o endereço geocodificado se encontra.

Geocoder Reverso

📥 Entradas

• latitude: Latitude da coordenada geográfica do ponto do qual se deseja analisar.
• longitude: Longitude da coordenada geográfica do ponto do qual se deseja analisar.

📦 Atributos Retornados

• cep: CEP (Código de Endereçamento Postal) do endereço geocodificado reversamente
• distancia_m: a distância em metros entre a latitude a ser geocodificada e o endereço mais próximo encontrado
• endereco_completo: o endereço completo mais próximo da coordenada de entrada, formado pela composição de todos os demais campos
• latitude_endereco: latitude do endereço mais próximo à coordenada geográfica de entrada.
• latitude_input: latitude fornecida como entrada para a geocodiicação reversa.
• localidade: nome do bairro ou região do endereço geocodificado reversamente.
• logradouro: nome do logradouro em que o endereço geocodificado reversamente se encontra.
• longitude_endereco: longitude do endereço mais próximo a coordenada geográfica de entrada.
• longitude_input: longitude fornecida como entrada para a geocodificação reversa.
• municipio: nome do município em que o endereço geocodificado reversamente se encontra.
• numero: número em relação ao logradouro em que o endereço geocodificado reversamente se encontra.
• uf: sigla da unidade federativa em que o endereço geocodificado reversamente se encontra.

🔁 Atualizações

Base atualizada mensalmente. Algoritmo atualizado constantemente.

📚 Fontes

• IBGE
• OpenStreetMap
• Overture Maps

⚙️ Metodologia

O geocoder surge a partir da agregação de diferentes bases de dados e de metologia própria da PrismaData para encontrar os endereços seja diretamente ou reversamente.

❗ Limitações