{"openapi":"3.1.0","info":{"title":"PrismaData — Validação de Endereços","version":"1.0.0","termsOfService":"https://prismadata.io/terms","contact":{"name":"PrismaData Support Team","url":"https://prismadata.io/contact","email":"suporte.api@prismadata.io"},"license":{"name":"Proprietary","url":"https://api.prismadata.io/license"},"description":"O validador de endereços consiste em validar um ou mais endereços com um ou mais\nsinais de localização (frequentemente obtidos por GPS). Os endereços são\ncomparados com os sinais indicando a concordância ou não da localização do(s)\nsinal(is) com o(s) endereço(s).\n\nMaiores informações podem ser encontradas na [documentação de produto](https://prismadata.io/doc-comercial/validacao-de-endereco/). Testes manuais com o fim de se compreender melhor o dado podem ser feitos [aqui](https://prismadata.io/testador-de-api/validacao-de-endereco-geo/).\n"},"servers":[{"url":"https://api.prismadata.io/v1","description":"Ambiente de Produção"}],"security":[{"X-Apikey":[]},{"api_key":[]},{"BearerAuth":[]}],"tags":[{"name":"Validação de Endereços","description":"O validador de endereços consiste em validar um ou mais endereços com um ou mais\nsinais de localização (frequentemente obtidos por GPS). Os endereços são\ncomparados com os sinais indicando a concordância ou não da localização do(s)\nsinal(is) com o(s) endereço(s).\n\nMaiores informações podem ser encontradas na [documentação de produto](https://prismadata.io/doc-comercial/validacao-de-endereco/). Testes manuais com o fim de se compreender melhor o dado podem ser feitos [aqui](https://prismadata.io/testador-de-api/validacao-de-endereco-geo/).\n"}],"paths":{"/location/addr_validation/compare_address":{"get":{"tags":["Validação de Endereços"],"summary":"Concordância entre endereço e coordenada","description":"Realiza a comparação de um endereço com determinada coordenada geográfica\npara avaliar a concordância (proximidade) entre eles.","operationId":"compare_address_compare_address_get","parameters":[{"name":"lat","in":"query","required":true,"schema":{"type":"number","exclusiveMaximum":90,"exclusiveMinimum":-90,"description":"Latitude do ponto que se deseja realizar a geocodificação reversa","title":"Lat"},"description":"Latitude do ponto que se deseja realizar a geocodificação reversa"},{"name":"lng","in":"query","required":true,"schema":{"type":"number","exclusiveMaximum":180,"exclusiveMinimum":-180,"description":"Longitude do ponto que se deseja realizar a geocodificação reversa","title":"Lng"},"description":"Longitude do ponto que se deseja realizar a geocodificação reversa"},{"name":"endereco_completo","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Endereço completo a ser geocodificado. Não é\n            necessário informá-lo caso os campos que compõem o endereço sejam\n            fornecidos separadamente","title":"Endereco Completo"},"description":"Endereço completo a ser geocodificado. Não é\n            necessário informá-lo caso os campos que compõem o endereço sejam\n            fornecidos separadamente"},{"name":"cep","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"integer"}],"maxLength":9},{"type":"null"}],"description":"CEP do endereço a ser geocodificado.","title":"Cep"},"description":"CEP do endereço a ser geocodificado.","example":"30130-165"},{"name":"numero","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"integer"}],"maxLength":10},{"type":"null"}],"description":"Numero do endereço a ser geocodificado","title":"Numero"},"description":"Numero do endereço a ser geocodificado"},{"name":"tipo_logradouro","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"description":"Tipo do logradouro a ser geocodificado.Ex: Rua, Avenida, etc.","title":"Tipo Logradouro"},"description":"Tipo do logradouro a ser geocodificado.Ex: Rua, Avenida, etc."},{"name":"titulo_logradouro","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"description":"Ex: Coronel, Senhor, Senhora, Professor, São, etc","title":"Titulo Logradouro"},"description":"Ex: Coronel, Senhor, Senhora, Professor, São, etc"},{"name":"logradouro","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"O logradouro a ser geocodificado","title":"Logradouro"},"description":"O logradouro a ser geocodificado"},{"name":"localidade","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":50},{"type":"null"}],"description":"Localidade do endereço. Frequentemente a localidade é o bairro ou região do endereço.","title":"Localidade"},"description":"Localidade do endereço. Frequentemente a localidade é o bairro ou região do endereço."},{"name":"municipio","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":50},{"type":"null"}],"description":"Município do endereço.","title":"Municipio"},"description":"Município do endereço."},{"name":"estado","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":15},{"type":"null"}],"description":"Unidade Federativa ou Estado do endereço.","title":"Estado"},"description":"Unidade Federativa ou Estado do endereço."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"CompareAddressResponse","properties":{"prismadata__valida_endereco_compare__classificacao_campos_endereco":{"type":"string","description":"Classificação de concordância geral dos campos do endereço"},"prismadata__valida_endereco_compare__classificacao_cep":{"type":"string","description":"Classificação de concordância do CEP"},"prismadata__valida_endereco_compare__classificacao_distancia_geodesica":{"type":"string","description":"Classificação de concordância da distância geodésica"},"prismadata__valida_endereco_compare__classificacao_final":{"type":"string","description":"Classificação final de concordância entre endereço e coordenada"},"prismadata__valida_endereco_compare__classificacao_localidade":{"type":"string","description":"Classificação de concordância da localidade"},"prismadata__valida_endereco_compare__classificacao_logradouro":{"type":"string","description":"Classificação de concordância do logradouro"},"prismadata__valida_endereco_compare__classificacao_municipio":{"type":"string","description":"Classificação de concordância do município"},"prismadata__valida_endereco_compare__classificacao_numero":{"type":"string","description":"Classificação de concordância do número"},"prismadata__valida_endereco_compare__classificacao_uf":{"type":"string","description":"Classificação de concordância da unidade federativa"},"prismadata__valida_endereco_compare__distancia_geodesica_m":{"type":"number","description":"Distância geodésica em metros entre o endereço geocodificado e a coordenada informada"},"prismadata__valida_endereco_compare__score_campos_endereco":{"type":"number","description":"Score de concordância geral dos campos do endereço"},"prismadata__valida_endereco_compare__score_cep":{"type":"number","description":"Score de concordância do CEP"},"prismadata__valida_endereco_compare__score_distancia_geodescia":{"type":"number","description":"Score de concordância da distância geodésica"},"prismadata__valida_endereco_compare__score_final":{"type":"number","description":"Score final de concordância entre endereço e coordenada"},"prismadata__valida_endereco_compare__score_localidade":{"type":"number","description":"Score de concordância da localidade"},"prismadata__valida_endereco_compare__score_logradouro":{"type":"number","description":"Score de concordância do logradouro"},"prismadata__valida_endereco_compare__score_municipio":{"type":"number","description":"Score de concordância do município"},"prismadata__valida_endereco_compare__score_numero":{"type":"number","description":"Score de concordância do número"},"prismadata__valida_endereco_compare__score_uf":{"type":"number","description":"Score de concordância da unidade federativa"},"prismadata__valida_endereco_compare__sucesso_geocodificacao_direta":{"type":"string","description":"Indica se a geocodificação direta foi realizada com sucesso"},"prismadata__valida_endereco_compare__sucesso_geocodificacao_reversa":{"type":"string","description":"Indica se a geocodificação reversa foi realizada com sucesso"}},"required":["prismadata__valida_endereco_compare__classificacao_campos_endereco","prismadata__valida_endereco_compare__classificacao_cep","prismadata__valida_endereco_compare__classificacao_distancia_geodesica","prismadata__valida_endereco_compare__classificacao_final","prismadata__valida_endereco_compare__classificacao_localidade","prismadata__valida_endereco_compare__classificacao_logradouro","prismadata__valida_endereco_compare__classificacao_municipio","prismadata__valida_endereco_compare__classificacao_numero","prismadata__valida_endereco_compare__classificacao_uf","prismadata__valida_endereco_compare__distancia_geodesica_m","prismadata__valida_endereco_compare__score_campos_endereco","prismadata__valida_endereco_compare__score_cep","prismadata__valida_endereco_compare__score_distancia_geodescia","prismadata__valida_endereco_compare__score_final","prismadata__valida_endereco_compare__score_localidade","prismadata__valida_endereco_compare__score_logradouro","prismadata__valida_endereco_compare__score_municipio","prismadata__valida_endereco_compare__score_numero","prismadata__valida_endereco_compare__score_uf","prismadata__valida_endereco_compare__sucesso_geocodificacao_direta","prismadata__valida_endereco_compare__sucesso_geocodificacao_reversa"]},"example":{"prismadata__valida_endereco_compare__classificacao_campos_endereco":"MUITO_PROXIMO","prismadata__valida_endereco_compare__classificacao_cep":"PROXIMO","prismadata__valida_endereco_compare__classificacao_distancia_geodesica":"IGUAL","prismadata__valida_endereco_compare__classificacao_final":"MUITO_PROXIMO","prismadata__valida_endereco_compare__classificacao_localidade":"IGUAL","prismadata__valida_endereco_compare__classificacao_logradouro":"MUITO_DISTANTE","prismadata__valida_endereco_compare__classificacao_municipio":"IGUAL","prismadata__valida_endereco_compare__classificacao_numero":"PROXIMO","prismadata__valida_endereco_compare__classificacao_uf":"IGUAL","prismadata__valida_endereco_compare__distancia_geodesica_m":62.926660837194,"prismadata__valida_endereco_compare__score_campos_endereco":88.29072803942488,"prismadata__valida_endereco_compare__score_cep":46.24072803942488,"prismadata__valida_endereco_compare__score_distancia_geodescia":100,"prismadata__valida_endereco_compare__score_final":94.14536401971245,"prismadata__valida_endereco_compare__score_localidade":5,"prismadata__valida_endereco_compare__score_logradouro":0.6,"prismadata__valida_endereco_compare__score_municipio":20,"prismadata__valida_endereco_compare__score_numero":6.45,"prismadata__valida_endereco_compare__score_uf":10,"prismadata__valida_endereco_compare__sucesso_geocodificacao_direta":"True","prismadata__valida_endereco_compare__sucesso_geocodificacao_reversa":"True"}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"401":{"description":"Unauthorized - Missing or invalid API key (X-Apikey header or api_key query parameter)","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"403":{"description":"Forbidden - Missing privileges to retrieve data","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"422":{"description":"Validation Error","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"429":{"$ref":"#/components/responses/RateLimitExceeded"}},"x-codeSamples":[{"lang":"curl","source":"curl \"https://api.prismadata.io/v1/location/addr_validation/compare_address?lat=-25.5&lng=-25.5&cep=30130-165\" \\\n  -H \"X-Apikey: ak_xxxxxxxxxxxxxxxx\""},{"lang":"Python","source":"import httpx\n\nresp = httpx.get(\n    \"https://api.prismadata.io/v1/location/addr_validation/compare_address\",\n    params={\"lat\": -25.5, \"lng\": -25.5, \"cep\": '30130-165'},\n    headers={\"X-Apikey\": \"ak_xxxxxxxxxxxxxxxx\"},\n)\ndados = resp.json()"},{"lang":"Python SDK","source":"from prismadata import Client\n\nclient = Client(api_key=\"ak_xxxxxxxxxxxxxxxx\")\nresult = client.compare_address(\n    lat=-23.55,\n    lng=-46.63,\n    full_address=\"Av Paulista 1000, Sao Paulo\",\n)\nprint(result)"},{"lang":"R SDK","source":"library(prismadata)\n\nclient <- prismadata_client(api_key = \"ak_xxxxxxxxxxxxxxxx\")\nresult <- client$compare_address(\n  lat = -23.55,\n  lng = -46.63,\n  full_address = \"Av Paulista 1000, Sao Paulo, SP\"\n)\nprint(result)"},{"lang":"TypeScript SDK","source":"import { PrismaDataClient } from \"prismadata\";\n\nconst client = new PrismaDataClient({ apiKey: \"ak_xxxxxxxxxxxxxxxx\" });\nconst result = await client.compareAddress(-23.55, -46.63, {\n  fullAddress: \"Av Paulista 1000, Sao Paulo\",\n});\nconsole.log(result);"}]}},"/location/addr_validation/validate_addr":{"post":{"tags":["Validação de Endereços"],"summary":"Valida endereços contra histórico de localização","description":"Valida uma lista de endereços com base no histórico de localização de um\ndispositivo. A validação indica se cada endereço da lista possui alguma\nrelação com o dispositivo, como \"MORADIA\", \"TRABALHO\", \"ATIPICO\", etc.","operationId":"validate_endereco_validate_addr_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_validate_endereco_validate_addr_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"prismadata__valida_endereco__classificacao__atipico":{"type":"integer","description":"Score de classificação como comportamento atípico (0 a 100)"},"prismadata__valida_endereco__classificacao__moradia":{"type":"integer","description":"Score de classificação como moradia (0 a 100)"},"prismadata__valida_endereco__classificacao__proximidade":{"type":"integer","description":"Score de classificação como proximidade (0 a 100)"},"prismadata__valida_endereco__classificacao__trabalho":{"type":"integer","description":"Score de classificação como trabalho (0 a 100)"},"prismadata__valida_endereco__classificacao__visita_eventual":{"type":"integer","description":"Score de classificação como visita eventual (0 a 100)"},"prismadata__valida_endereco__classificacao__visita_frequente":{"type":"integer","description":"Score de classificação como visita frequente (0 a 100)"},"prismadata__valida_endereco__classificacao_provavel":{"type":"string","description":"Classificação provável do endereço em relação ao dispositivo (MORADIA, TRABALHO, PROXIMIDADE, ATIPICO, VISITA_FREQUENTE, VISITA_EVENTUAL)"},"prismadata__valida_endereco__endereco_validado":{"type":"string","description":"Endereço formatado utilizado na validação"},"prismadata__valida_endereco__geocoder__cep":{"type":"string","description":"CEP retornado pela geocodificação"},"prismadata__valida_endereco__geocoder__classificacao_qualidade_geocodificacao":{"type":"string","description":"Classificação da qualidade da geocodificação (MUITO_ALTA, ALTA, MEDIA, BAIXA)"},"prismadata__valida_endereco__geocoder__endereco_completo":{"type":"string","description":"Endereço completo retornado pela geocodificação"},"prismadata__valida_endereco__geocoder__latitude":{"type":"number","description":"Latitude do endereço geocodificado"},"prismadata__valida_endereco__geocoder__localidade":{"type":"string","description":"Localidade (bairro/região) retornada pela geocodificação"},"prismadata__valida_endereco__geocoder__logradouro":{"type":"string","description":"Logradouro retornado pela geocodificação"},"prismadata__valida_endereco__geocoder__longitude":{"type":"number","description":"Longitude do endereço geocodificado"},"prismadata__valida_endereco__geocoder__municipio":{"type":"string","description":"Município retornado pela geocodificação"},"prismadata__valida_endereco__geocoder__numero":{"type":"integer","description":"Número do endereço retornado pela geocodificação"},"prismadata__valida_endereco__geocoder__score_qualidade_geocodificacao":{"type":"number","description":"Score numérico da qualidade da geocodificação (0 a 100)"},"prismadata__valida_endereco__geocoder__uf":{"type":"string","description":"Unidade federativa retornada pela geocodificação"}},"type":"object","required":["prismadata__valida_endereco__classificacao__atipico","prismadata__valida_endereco__classificacao__moradia","prismadata__valida_endereco__classificacao__proximidade","prismadata__valida_endereco__classificacao__trabalho","prismadata__valida_endereco__classificacao__visita_eventual","prismadata__valida_endereco__classificacao__visita_frequente","prismadata__valida_endereco__classificacao_provavel","prismadata__valida_endereco__endereco_validado","prismadata__valida_endereco__geocoder__cep","prismadata__valida_endereco__geocoder__classificacao_qualidade_geocodificacao","prismadata__valida_endereco__geocoder__endereco_completo","prismadata__valida_endereco__geocoder__latitude","prismadata__valida_endereco__geocoder__localidade","prismadata__valida_endereco__geocoder__logradouro","prismadata__valida_endereco__geocoder__longitude","prismadata__valida_endereco__geocoder__municipio","prismadata__valida_endereco__geocoder__numero","prismadata__valida_endereco__geocoder__score_qualidade_geocodificacao","prismadata__valida_endereco__geocoder__uf"],"title":"ValidateAddrItem"},"type":"array","description":"Lista de resultados de validação para cada endereço informado"}},"type":"object","required":["items"],"title":"ValidateAddrResponse"},"example":{"items":[{"prismadata__valida_endereco__classificacao__atipico":0,"prismadata__valida_endereco__classificacao__moradia":83,"prismadata__valida_endereco__classificacao__proximidade":100,"prismadata__valida_endereco__classificacao__trabalho":83,"prismadata__valida_endereco__classificacao__visita_eventual":0,"prismadata__valida_endereco__classificacao__visita_frequente":7,"prismadata__valida_endereco__classificacao_provavel":"MORADIA","prismadata__valida_endereco__endereco_validado":"Av. Artur Bernardes 216, Vila Paris - Belo Horizonte - MG","prismadata__valida_endereco__geocoder__cep":"30380-752","prismadata__valida_endereco__geocoder__classificacao_qualidade_geocodificacao":"MUITO_ALTA","prismadata__valida_endereco__geocoder__endereco_completo":"AVENIDA ARTUR BERNARDES, 216 - VILA PARIS, BELO HORIZONTE - MG, 30380-752","prismadata__valida_endereco__geocoder__latitude":-19.949094772338867,"prismadata__valida_endereco__geocoder__localidade":"VILA PARIS","prismadata__valida_endereco__geocoder__logradouro":"AVENIDA ARTUR BERNARDES","prismadata__valida_endereco__geocoder__longitude":-43.9478874206543,"prismadata__valida_endereco__geocoder__municipio":"BELO HORIZONTE","prismadata__valida_endereco__geocoder__numero":216,"prismadata__valida_endereco__geocoder__score_qualidade_geocodificacao":100.0,"prismadata__valida_endereco__geocoder__uf":"MG"},{"prismadata__valida_endereco__classificacao__atipico":0,"prismadata__valida_endereco__classificacao__moradia":0,"prismadata__valida_endereco__classificacao__proximidade":100,"prismadata__valida_endereco__classificacao__trabalho":0,"prismadata__valida_endereco__classificacao__visita_eventual":0,"prismadata__valida_endereco__classificacao__visita_frequente":0,"prismadata__valida_endereco__classificacao_provavel":"PROXIMIDADE","prismadata__valida_endereco__endereco_validado":"Rua São João Evangelista, 185, São Pedro - Belo Horizonte - MG","prismadata__valida_endereco__geocoder__cep":"30330-152","prismadata__valida_endereco__geocoder__classificacao_qualidade_geocodificacao":"MUITO_ALTA","prismadata__valida_endereco__geocoder__endereco_completo":"RUA SAO JOAO EVANGELISTA, 185 - SAO PEDRO, BELO HORIZONTE - MG, 30330-152","prismadata__valida_endereco__geocoder__latitude":-19.947734832763672,"prismadata__valida_endereco__geocoder__localidade":"SAO PEDRO","prismadata__valida_endereco__geocoder__logradouro":"RUA SAO JOAO EVANGELISTA","prismadata__valida_endereco__geocoder__longitude":-43.937156677246094,"prismadata__valida_endereco__geocoder__municipio":"BELO HORIZONTE","prismadata__valida_endereco__geocoder__numero":185,"prismadata__valida_endereco__geocoder__score_qualidade_geocodificacao":100.0,"prismadata__valida_endereco__geocoder__uf":"MG"},{"prismadata__valida_endereco__classificacao__atipico":100,"prismadata__valida_endereco__classificacao__moradia":0,"prismadata__valida_endereco__classificacao__proximidade":0,"prismadata__valida_endereco__classificacao__trabalho":0,"prismadata__valida_endereco__classificacao__visita_eventual":0,"prismadata__valida_endereco__classificacao__visita_frequente":0,"prismadata__valida_endereco__classificacao_provavel":"ATIPICO","prismadata__valida_endereco__endereco_validado":"Av. Vieira Souto, 302 - Ipanema - Rio de Janeiro - RJ","prismadata__valida_endereco__geocoder__cep":"22420-004","prismadata__valida_endereco__geocoder__classificacao_qualidade_geocodificacao":"MEDIA","prismadata__valida_endereco__geocoder__endereco_completo":"AVENIDA VIEIRA SOUTO, 284 - IPANEMA, RIO DE JANEIRO - RJ, 22420-004","prismadata__valida_endereco__geocoder__latitude":-22.986597061157227,"prismadata__valida_endereco__geocoder__localidade":"IPANEMA","prismadata__valida_endereco__geocoder__logradouro":"AVENIDA VIEIRA SOUTO","prismadata__valida_endereco__geocoder__longitude":-43.201576232910156,"prismadata__valida_endereco__geocoder__municipio":"RIO DE JANEIRO","prismadata__valida_endereco__geocoder__numero":284,"prismadata__valida_endereco__geocoder__score_qualidade_geocodificacao":50.0,"prismadata__valida_endereco__geocoder__uf":"RJ"},{"prismadata__valida_endereco__classificacao__atipico":0,"prismadata__valida_endereco__classificacao__moradia":0,"prismadata__valida_endereco__classificacao__proximidade":100,"prismadata__valida_endereco__classificacao__trabalho":0,"prismadata__valida_endereco__classificacao__visita_eventual":0,"prismadata__valida_endereco__classificacao__visita_frequente":0,"prismadata__valida_endereco__classificacao_provavel":"PROXIMIDADE","prismadata__valida_endereco__endereco_validado":"Av. Paulista, 1578 - Bela Vista, São Paulo - SP, 01310-200","prismadata__valida_endereco__geocoder__cep":"01310-200","prismadata__valida_endereco__geocoder__classificacao_qualidade_geocodificacao":"MUITO_ALTA","prismadata__valida_endereco__geocoder__endereco_completo":"AVENIDA PAULISTA, 1578 - BELA VISTA, SAO PAULO - SP, 01310-200","prismadata__valida_endereco__geocoder__latitude":-23.562049865722656,"prismadata__valida_endereco__geocoder__localidade":"BELA VISTA","prismadata__valida_endereco__geocoder__logradouro":"AVENIDA PAULISTA","prismadata__valida_endereco__geocoder__longitude":-46.65565490722656,"prismadata__valida_endereco__geocoder__municipio":"SAO PAULO","prismadata__valida_endereco__geocoder__numero":1578,"prismadata__valida_endereco__geocoder__score_qualidade_geocodificacao":100.0,"prismadata__valida_endereco__geocoder__uf":"SP"}]}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"401":{"description":"Unauthorized - Missing or invalid API key (X-Apikey header or api_key query parameter)","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"403":{"description":"Forbidden - Missing privileges to retrieve data","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"422":{"description":"Validation Error","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"429":{"$ref":"#/components/responses/RateLimitExceeded"}},"x-codeSamples":[{"lang":"curl","source":"curl -X POST \"https://api.prismadata.io/v1/location/addr_validation/validate_addr\" \\\n  -H \"X-Apikey: ak_xxxxxxxxxxxxxxxx\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ ... }'"},{"lang":"Python","source":"import httpx\n\nresp = httpx.post(\n    \"https://api.prismadata.io/v1/location/addr_validation/validate_addr\",\n    json={...},\n    headers={\"X-Apikey\": \"ak_xxxxxxxxxxxxxxxx\"},\n)\ndados = resp.json()"},{"lang":"Python SDK","source":"from prismadata import Client\n\nclient = Client(api_key=\"ak_xxxxxxxxxxxxxxxx\")\nresult = client.validate_address(\n    locations=[[-23.55, -46.63, 1700000000]],\n    addresses=[\"Av Paulista 1000, Sao Paulo\"],\n)\nprint(result)"}]}},"/location/addr_validation/cluster_location_historic":{"post":{"tags":["Validação de Endereços"],"summary":"Agrupa histórico de localização em locais frequentes","description":"Realiza uma clusterização espacial dos pontos para identificar locais em que\nos sinais de localização são frequentes ou prolongados. Além disso, com as\ninformações de timestamp classifica em diferentes graus, qual a afinidade do\ncluster com as seguintes classificações para o centróide do cluster:\n\n1. MORADIA\n2. TRABALHO\n3. VISITA_FREQUENTE\n4. VISITA_EVENTUAL","operationId":"cluster_location_cluster_location_historic_post","requestBody":{"content":{"application/json":{"schema":{"items":{"prefixItems":[{"type":"number"},{"type":"number"},{"type":"number"}],"type":"array","maxItems":3,"minItems":3},"type":"array","title":"Locations","description":"Lista de tuplas contendo sinais de localização."}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"prismadata__cluster_historic_location__cep":{"type":"string","description":"CEP do centróide do cluster"},"prismadata__cluster_historic_location__cluster_id":{"type":"integer","description":"Identificador único do cluster"},"prismadata__cluster_historic_location__cod_municipio":{"type":"integer","description":"Código IBGE do município do centróide do cluster"},"prismadata__cluster_historic_location__distancia_m":{"type":"number","description":"Distância em metros entre o centróide do cluster e o endereço geocodificado"},"prismadata__cluster_historic_location__endereco_completo":{"type":"string","description":"Endereço completo do centróide do cluster obtido por geocodificação reversa"},"prismadata__cluster_historic_location__latitude_endereco":{"type":"number","description":"Latitude do endereço geocodificado do centróide do cluster"},"prismadata__cluster_historic_location__latitude_input":{"type":"number","description":"Latitude do centróide calculado do cluster"},"prismadata__cluster_historic_location__localidade":{"type":"string","description":"Localidade (bairro/região) do centróide do cluster"},"prismadata__cluster_historic_location__logradouro":{"type":"string","description":"Logradouro do centróide do cluster"},"prismadata__cluster_historic_location__longitude_endereco":{"type":"number","description":"Longitude do endereço geocodificado do centróide do cluster"},"prismadata__cluster_historic_location__longitude_input":{"type":"number","description":"Longitude do centróide calculado do cluster"},"prismadata__cluster_historic_location__moradia":{"type":"number","description":"Score bruto de classificação como moradia"},"prismadata__cluster_historic_location__moradia_normalizado":{"type":"number","description":"Score normalizado de classificação como moradia (0 a 1)"},"prismadata__cluster_historic_location__municipio":{"type":"string","description":"Município do centróide do cluster"},"prismadata__cluster_historic_location__numero":{"type":"integer","description":"Número do endereço do centróide do cluster"},"prismadata__cluster_historic_location__trabalho":{"type":"number","description":"Score bruto de classificação como trabalho"},"prismadata__cluster_historic_location__trabalho_normalizado":{"type":"number","description":"Score normalizado de classificação como trabalho (0 a 1)"},"prismadata__cluster_historic_location__uf":{"type":"string","description":"Unidade federativa do centróide do cluster"},"prismadata__cluster_historic_location__visita_eventual":{"type":"number","description":"Score bruto de classificação como visita eventual"},"prismadata__cluster_historic_location__visita_eventual_normalizado":{"type":"number","description":"Score normalizado de classificação como visita eventual (0 a 1)"},"prismadata__cluster_historic_location__visita_frequente":{"type":"number","description":"Score bruto de classificação como visita frequente"},"prismadata__cluster_historic_location__visita_frequente_normalizado":{"type":"number","description":"Score normalizado de classificação como visita frequente (0 a 1)"}},"type":"object","required":["prismadata__cluster_historic_location__cep","prismadata__cluster_historic_location__cluster_id","prismadata__cluster_historic_location__cod_municipio","prismadata__cluster_historic_location__distancia_m","prismadata__cluster_historic_location__endereco_completo","prismadata__cluster_historic_location__latitude_endereco","prismadata__cluster_historic_location__latitude_input","prismadata__cluster_historic_location__localidade","prismadata__cluster_historic_location__logradouro","prismadata__cluster_historic_location__longitude_endereco","prismadata__cluster_historic_location__longitude_input","prismadata__cluster_historic_location__moradia","prismadata__cluster_historic_location__moradia_normalizado","prismadata__cluster_historic_location__municipio","prismadata__cluster_historic_location__numero","prismadata__cluster_historic_location__trabalho","prismadata__cluster_historic_location__trabalho_normalizado","prismadata__cluster_historic_location__uf","prismadata__cluster_historic_location__visita_eventual","prismadata__cluster_historic_location__visita_eventual_normalizado","prismadata__cluster_historic_location__visita_frequente","prismadata__cluster_historic_location__visita_frequente_normalizado"],"title":"ClusterLocationItem"},"type":"array","description":"Lista de clusters identificados a partir do histórico de localização"}},"type":"object","required":["items"],"title":"ClusterLocationHistoricResponse"},"example":{"items":[{"prismadata__cluster_historic_location__cep":"30380-752","prismadata__cluster_historic_location__cluster_id":0,"prismadata__cluster_historic_location__cod_municipio":3106200,"prismadata__cluster_historic_location__distancia_m":12.64653078,"prismadata__cluster_historic_location__endereco_completo":"AVENIDA  ARTUR BERNARDES, 228 - VILA PARIS, BELO HORIZONTE - MG, 30380-752","prismadata__cluster_historic_location__latitude_endereco":-19.950218200683594,"prismadata__cluster_historic_location__latitude_input":-19.950141,"prismadata__cluster_historic_location__localidade":"VILA PARIS","prismadata__cluster_historic_location__logradouro":"AVENIDA  ARTUR BERNARDES","prismadata__cluster_historic_location__longitude_endereco":-43.947635650634766,"prismadata__cluster_historic_location__longitude_input":-43.9477247,"prismadata__cluster_historic_location__moradia":0.5853592589109377,"prismadata__cluster_historic_location__moradia_normalizado":0.9687919528377141,"prismadata__cluster_historic_location__municipio":"BELO HORIZONTE","prismadata__cluster_historic_location__numero":228,"prismadata__cluster_historic_location__trabalho":0.5158601560896914,"prismadata__cluster_historic_location__trabalho_normalizado":0.9704367271420395,"prismadata__cluster_historic_location__uf":"MG","prismadata__cluster_historic_location__visita_eventual":0.0024057361519826295,"prismadata__cluster_historic_location__visita_eventual_normalizado":0.0011620985380875505,"prismadata__cluster_historic_location__visita_frequente":0.0348831742037481,"prismadata__cluster_historic_location__visita_frequente_normalizado":0.08406721888423925},{"prismadata__cluster_historic_location__cep":"30160-019","prismadata__cluster_historic_location__cluster_id":1,"prismadata__cluster_historic_location__cod_municipio":3106200,"prismadata__cluster_historic_location__distancia_m":42.60808378,"prismadata__cluster_historic_location__endereco_completo":"RUA  DA BAHIA, 2425 - SAVASSI, BELO HORIZONTE - MG, 30160-019","prismadata__cluster_historic_location__latitude_endereco":-19.93621253967285,"prismadata__cluster_historic_location__latitude_input":-19.9359977,"prismadata__cluster_historic_location__localidade":"SAVASSI","prismadata__cluster_historic_location__logradouro":"RUA  DA BAHIA","prismadata__cluster_historic_location__longitude_endereco":-43.940513610839844,"prismadata__cluster_historic_location__longitude_input":-43.9408513,"prismadata__cluster_historic_location__moradia":0.013448697451330763,"prismadata__cluster_historic_location__moradia_normalizado":0.022258108449909525,"prismadata__cluster_historic_location__municipio":"BELO HORIZONTE","prismadata__cluster_historic_location__numero":2425,"prismadata__cluster_historic_location__trabalho":0.012064049133581927,"prismadata__cluster_historic_location__trabalho_normalizado":0.02269490329708361,"prismadata__cluster_historic_location__uf":"MG","prismadata__cluster_historic_location__visita_eventual":0.5574400106335522,"prismadata__cluster_historic_location__visita_eventual_normalizado":0.26927317897887126,"prismadata__cluster_historic_location__visita_frequente":0.3065920058484537,"prismadata__cluster_historic_location__visita_frequente_normalizado":0.7388759151697422},{"prismadata__cluster_historic_location__cep":"06470-000","prismadata__cluster_historic_location__cluster_id":2,"prismadata__cluster_historic_location__cod_municipio":3505708,"prismadata__cluster_historic_location__distancia_m":20.80692223,"prismadata__cluster_historic_location__endereco_completo":"ALAMEDA  VENEZUELA, 862 - ALPHAVILLE 2, BARUERI - SP, 06470-000","prismadata__cluster_historic_location__latitude_endereco":-23.492918014526367,"prismadata__cluster_historic_location__latitude_input":-23.4927481,"prismadata__cluster_historic_location__localidade":"ALPHAVILLE 2","prismadata__cluster_historic_location__logradouro":"ALAMEDA  VENEZUELA","prismadata__cluster_historic_location__longitude_endereco":-46.861968994140625,"prismadata__cluster_historic_location__longitude_input":-46.8620559,"prismadata__cluster_historic_location__moradia":0.004796388601523559,"prismadata__cluster_historic_location__moradia_normalizado":0.007938206510107593,"prismadata__cluster_historic_location__municipio":"BARUERI","prismadata__cluster_historic_location__numero":862,"prismadata__cluster_historic_location__trabalho":0.003000091983952338,"prismadata__cluster_historic_location__trabalho_normalizado":0.0056437765383949845,"prismadata__cluster_historic_location__uf":"SP","prismadata__cluster_historic_location__visita_eventual":0.6489826034166849,"prismadata__cluster_historic_location__visita_eventual_normalizado":0.3134931210362539,"prismadata__cluster_historic_location__visita_frequente":0.04475742092528861,"prismadata__cluster_historic_location__visita_frequente_normalizado":0.10786380504375039},{"prismadata__cluster_historic_location__cep":"30140-100","prismadata__cluster_historic_location__cluster_id":3,"prismadata__cluster_historic_location__cod_municipio":3106200,"prismadata__cluster_historic_location__distancia_m":9.39547144,"prismadata__cluster_historic_location__endereco_completo":"RUA  CLAUDIO MANOEL, 862 - SAVASSI, BELO HORIZONTE - MG, 30140-100","prismadata__cluster_historic_location__latitude_endereco":-19.933401107788086,"prismadata__cluster_historic_location__latitude_input":-19.933324900000002,"prismadata__cluster_historic_location__localidade":"SAVASSI","prismadata__cluster_historic_location__logradouro":"RUA  CLAUDIO MANOEL","prismadata__cluster_historic_location__longitude_endereco":-43.93346405029297,"prismadata__cluster_historic_location__longitude_input":-43.93342455,"prismadata__cluster_historic_location__moradia":0.0006113044296059438,"prismadata__cluster_historic_location__moradia_normalizado":0.0010117322022686148,"prismadata__cluster_historic_location__municipio":"BELO HORIZONTE","prismadata__cluster_historic_location__numero":862,"prismadata__cluster_historic_location__trabalho":0.0006509633550085262,"prismadata__cluster_historic_location__trabalho_normalizado":0.0012245930224819308,"prismadata__cluster_historic_location__uf":"MG","prismadata__cluster_historic_location__visita_eventual":0.8613370214380509,"prismadata__cluster_historic_location__visita_eventual_normalizado":0.41607160144678723,"prismadata__cluster_historic_location__visita_frequente":0.028711234047935026,"prismadata__cluster_historic_location__visita_frequente_normalizado":0.06919306090226829}]}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"401":{"description":"Unauthorized - Missing or invalid API key (X-Apikey header or api_key query parameter)","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"403":{"description":"Forbidden - Missing privileges to retrieve data","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"422":{"description":"Validation Error","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"429":{"$ref":"#/components/responses/RateLimitExceeded"}},"x-codeSamples":[{"lang":"curl","source":"curl -X POST \"https://api.prismadata.io/v1/location/addr_validation/cluster_location_historic\" \\\n  -H \"X-Apikey: ak_xxxxxxxxxxxxxxxx\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ ... }'"},{"lang":"Python","source":"import httpx\n\nresp = httpx.post(\n    \"https://api.prismadata.io/v1/location/addr_validation/cluster_location_historic\",\n    json={...},\n    headers={\"X-Apikey\": \"ak_xxxxxxxxxxxxxxxx\"},\n)\ndados = resp.json()"},{"lang":"Python SDK","source":"from prismadata import Client\n\nclient = Client(api_key=\"ak_xxxxxxxxxxxxxxxx\")\nresult = client.cluster_locations(\n    locations=[\n        [-23.55, -46.63, 1700000000],\n        [-23.55, -46.63, 1700003600],\n    ]\n)\nprint(result)"},{"lang":"R SDK","source":"library(prismadata)\n\nclient <- prismadata_client(api_key = \"ak_xxxxxxxxxxxxxxxx\")\nlocations <- list(\n  c(-23.5505, -46.6333, \"2024-01-15T08:00:00\"),\n  c(-23.5510, -46.6340, \"2024-01-15T12:00:00\"),\n  c(-22.9068, -43.1729, \"2024-01-16T09:00:00\"),\n  c(-22.9075, -43.1735, \"2024-01-16T14:00:00\")\n)\n\nresult <- client$cluster_locations(locations = locations)\nprint(result)"},{"lang":"TypeScript SDK","source":"import { PrismaDataClient } from \"prismadata\";\n\nconst client = new PrismaDataClient({ apiKey: \"ak_xxxxxxxxxxxxxxxx\" });\nconst result = await client.clusterLocations([\n  [-23.55, -46.63, 1700000000],\n  [-23.55, -46.63, 1700003600],\n]);\nconsole.log(result);"}]}}},"components":{"securitySchemes":{"X-Apikey":{"type":"apiKey","in":"header","name":"X-Apikey","description":"Token de acesso via header."},"api_key":{"type":"apiKey","in":"query","name":"api_key","description":"Token de acesso via query parameter."},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT obtido via POST /auth/token"}},"headers":{"X-RateLimit-Limit":{"description":"Número máximo de requisições permitidas por minuto para o usuário.","schema":{"type":"integer","example":60}},"X-RateLimit-Remaining":{"description":"Número de requisições restantes na janela de rate limit atual.","schema":{"type":"integer","example":57}},"X-RateLimit-Reset":{"description":"Unix timestamp (segundos) indicando quando a janela de rate limit será reiniciada.","schema":{"type":"integer","example":1738281600}}},"responses":{"RateLimitExceeded":{"description":"Too Many Requests - Rate limit ou quota excedidos.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"text/plain":{"schema":{"type":"string"},"examples":{"rate_limit":{"summary":"Rate limit excedido","value":"rate limit exceeded"},"quota":{"summary":"Quota excedida","value":"limit exceeded: 1000 requests used, limit is 1000"}}}}}},"schemas":{"Body_validate_endereco_validate_addr_post":{"properties":{"locations":{"items":{"prefixItems":[{"type":"number"},{"type":"number"},{"type":"number"}],"type":"array","maxItems":3,"minItems":3},"type":"array","title":"Locations","description":"Lista de tuplas contendo sinais de localização."},"enderecos":{"items":{"type":"string"},"type":"array","maxItems":5,"title":"Enderecos","description":"Lista de endereços a serem validados"}},"type":"object","required":["locations","enderecos"],"title":"Body_validate_endereco_validate_addr_post"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}