{"openapi":"3.1.0","info":{"title":"PrismaData — Geocoder","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":"API de geocodificação de endereços brasileiros. Converte endereços em coordenadas GPS (geocodificação direta) e coordenadas em endereços (geocodificação reversa).\n\n## O que você recebe\n\nCada resposta traz:\n\n- **Coordenada** — latitude e longitude do endereço em WGS84.\n- **Endereço normalizado** — CEP, número, logradouro, localidade (frequentemente bairro), município e UF, com formato padrão da PrismaData.\n- **Score de qualidade** (0-100) e **classificação** (`MUITO_ALTA`, `ALTA`, `MEDIA`, `BAIXA`, `MUITO_BAIXA`, `NAO_GEOCODIFICADO`) — indicam o quão confiável é a resposta. Use como filtro antes de consumir o resultado.\n- **Metadados de correção** (opcional, em geocodificação direta) — setor censitário CNEFE, sinalizadores de interpolação entre vizinhos numéricos e de correção via faces IBGE quando aplicáveis.\n\nQuando o endereço não pode ser resolvido, os campos vêm vazios ou `null` — o endpoint continua respondendo `200 OK`. Cliente decide o que fazer.\n\n## Endpoints disponíveis\n\n| Endpoint | Método | Input | Limite |\n|---|---|---|---|\n| `/location/geocoder` | GET | Endereço estruturado (`cep`, `numero`, `logradouro`, `municipio`, `estado`, etc) ou string única (`endereco_completo`) | — |\n| `/location/reverse_geocoder` | GET | Coordenada `lat`, `lng` | — |\n| `/location/batch/geocoder` | POST | Dict de endereços indexados por chaves do cliente | **512** itens |\n| `/location/batch/reverse_geocoder` | POST | Dict de coordenadas indexadas por chaves do cliente | **1024** itens |\n\nNos endpoints batch, as chaves do dict de entrada são preservadas na resposta para facilitar a correlação client-side. Itens com erro vêm como `null` no respectivo slot.\n\n## Formato dos campos\n\nTodos os campos usam o prefixo `prismadata__geocoder__` (direto) ou `prismadata__reverse_geocoder__` (reverso), padrão dos produtos da PrismaData. Exemplo de payload de resposta direta:\n\n```json\n{\n  \"prismadata__geocoder__latitude\": -19.9328,\n  \"prismadata__geocoder__longitude\": -43.9356,\n  \"prismadata__geocoder__cep\": \"30130-165\",\n  \"prismadata__geocoder__numero\": 601,\n  \"prismadata__geocoder__logradouro\": \"RUA ALAGOAS\",\n  \"prismadata__geocoder__localidade\": \"SAVASSI\",\n  \"prismadata__geocoder__municipio\": \"BELO HORIZONTE\",\n  \"prismadata__geocoder__uf\": \"MG\",\n  \"prismadata__geocoder__endereco_completo\": \"RUA ALAGOAS, 601 - SAVASSI, BELO HORIZONTE - MG, 30130-165\",\n  \"prismadata__geocoder__score_qualidade_geocodificacao\": 99.5,\n  \"prismadata__geocoder__classificacao_qualidade_geocodificacao\": \"ALTA\"\n}\n```\n\n## Mais informações\n\nInformações comerciais em [prismadata.io/doc-comercial/geocoder/](https://prismadata.io/doc-comercial/geocoder/). Testes manuais com o fim de compreender melhor o dado podem ser feitos [aqui](https://prismadata.io/testador-de-api/api-de-localizacao/).\n"},"servers":[{"url":"https://api.prismadata.io/v1","description":"Ambiente de Produção"}],"security":[{"X-Apikey":[]},{"api_key":[]},{"BearerAuth":[]}],"tags":[{"name":"Geocoder","description":"API de geocodificação de endereços brasileiros. Converte endereços em coordenadas GPS (geocodificação direta) e coordenadas em endereços (geocodificação reversa).\n\n## O que você recebe\n\nCada resposta traz:\n\n- **Coordenada** — latitude e longitude do endereço em WGS84.\n- **Endereço normalizado** — CEP, número, logradouro, localidade (frequentemente bairro), município e UF, com formato padrão da PrismaData.\n- **Score de qualidade** (0-100) e **classificação** (`MUITO_ALTA`, `ALTA`, `MEDIA`, `BAIXA`, `MUITO_BAIXA`, `NAO_GEOCODIFICADO`) — indicam o quão confiável é a resposta. Use como filtro antes de consumir o resultado.\n- **Metadados de correção** (opcional, em geocodificação direta) — setor censitário CNEFE, sinalizadores de interpolação entre vizinhos numéricos e de correção via faces IBGE quando aplicáveis.\n\nQuando o endereço não pode ser resolvido, os campos vêm vazios ou `null` — o endpoint continua respondendo `200 OK`. Cliente decide o que fazer.\n\n## Endpoints disponíveis\n\n| Endpoint | Método | Input | Limite |\n|---|---|---|---|\n| `/location/geocoder` | GET | Endereço estruturado (`cep`, `numero`, `logradouro`, `municipio`, `estado`, etc) ou string única (`endereco_completo`) | — |\n| `/location/reverse_geocoder` | GET | Coordenada `lat`, `lng` | — |\n| `/location/batch/geocoder` | POST | Dict de endereços indexados por chaves do cliente | **512** itens |\n| `/location/batch/reverse_geocoder` | POST | Dict de coordenadas indexadas por chaves do cliente | **1024** itens |\n\nNos endpoints batch, as chaves do dict de entrada são preservadas na resposta para facilitar a correlação client-side. Itens com erro vêm como `null` no respectivo slot.\n\n## Formato dos campos\n\nTodos os campos usam o prefixo `prismadata__geocoder__` (direto) ou `prismadata__reverse_geocoder__` (reverso), padrão dos produtos da PrismaData. Exemplo de payload de resposta direta:\n\n```json\n{\n  \"prismadata__geocoder__latitude\": -19.9328,\n  \"prismadata__geocoder__longitude\": -43.9356,\n  \"prismadata__geocoder__cep\": \"30130-165\",\n  \"prismadata__geocoder__numero\": 601,\n  \"prismadata__geocoder__logradouro\": \"RUA ALAGOAS\",\n  \"prismadata__geocoder__localidade\": \"SAVASSI\",\n  \"prismadata__geocoder__municipio\": \"BELO HORIZONTE\",\n  \"prismadata__geocoder__uf\": \"MG\",\n  \"prismadata__geocoder__endereco_completo\": \"RUA ALAGOAS, 601 - SAVASSI, BELO HORIZONTE - MG, 30130-165\",\n  \"prismadata__geocoder__score_qualidade_geocodificacao\": 99.5,\n  \"prismadata__geocoder__classificacao_qualidade_geocodificacao\": \"ALTA\"\n}\n```\n\n## Mais informações\n\nInformações comerciais em [prismadata.io/doc-comercial/geocoder/](https://prismadata.io/doc-comercial/geocoder/). Testes manuais com o fim de compreender melhor o dado podem ser feitos [aqui](https://prismadata.io/testador-de-api/api-de-localizacao/).\n"}],"paths":{"/location/geocoder":{"get":{"tags":["Geocoder"],"summary":"Geocodifica um endereço (endereço → coordenada)","description":"Endpoint para se obter a latitude e longitude de um endereço.\n\nHá duas formas de se realizar a geocodificação:\n1. Fornecendo o endereço completo em uma única string (endereco_completo).\n2. Fornecendo os campos do endereço de forma individualizada.\n\nCaso o endereço completo seja fornecido, ele é quebrado nos campos\ninternamente e se os campos forém fornecidos também, estes têm preferência\nsobre os campos extraídos do endereço completo. Por isso, sugere-se que, se\npossível, a geocodificação seja feita pelos campos individualizados e não pelo\nendereço completo.","operationId":"geocoder_geocoder_get","parameters":[{"name":"endereco_completo","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Endereço completo a ser 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 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 do endereço","title":"Localidade"},"description":"Localidade do endereço. Frequentemente a localidade é o Bairro 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":{"description":"Modelo com a resposta esperada da API","properties":{"prismadata__geocoder__cep":{"description":"CEP da coordenada do endereço geocodificado","title":"Prismadata  Geocoder  Cep","type":"string"},"prismadata__geocoder__cod_setor_cnefe":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Código do setor censitário IBGE 2022 (15 dígitos) do\n    endereço geocodificado. `null` para os ~2% de endereços sem\n    correção CNEFE-Faces.","title":"Prismadata  Geocoder  Cod Setor Cnefe"},"prismadata__geocoder__classificacao_qualidade_geocodificacao":{"description":"Classe de qualidade da geocodificação, derivada do score (0-100):\n- `MUITO_ALTA` (score 100): endereço localizado com a maior confiança.\n- `ALTA` (score de 90 a menos de 100): endereço localizado com alta confiança.\n- `MEDIA` (score de 50 a menos de 90): localização plausível; vale conferir em usos sensíveis.\n- `BAIXA` (score de 30 a menos de 50): localização incerta; valide antes de usar.\n- `MUITO_BAIXA` (score acima de 0 e abaixo de 30): localização pouco confiável; não use sem validação.\n- `CENTROIDE_MUNICIPIO` (score 5): o endereço não foi localizado, mas o município foi; a coordenada é o centro do município, sem precisão de endereço.\n- `NAO_GEOCODIFICADO` (score 0): não foi possível localizar o endereço (ex.: texto ininteligível); a coordenada não deve ser usada.","enum":["MUITO_ALTA","ALTA","MEDIA","BAIXA","MUITO_BAIXA","CENTROIDE_MUNICIPIO","NAO_GEOCODIFICADO"],"title":"Prismadata  Geocoder  Classificacao Qualidade Geocodificacao","type":"string"},"prismadata__geocoder__endereco_completo":{"description":"Endereço completo da coordenada geocodificada","title":"Prismadata  Geocoder  Endereco Completo","type":"string"},"prismadata__geocoder__latitude":{"description":"Latitude da coordenada do endereço geocodificado.","title":"Prismadata  Geocoder  Latitude","type":"number"},"prismadata__geocoder__localidade":{"description":"Nome da localidade da coordenada geocodificada. \n    Frequentemente é o nome do bairro ou da região.","title":"Prismadata  Geocoder  Localidade","type":"string"},"prismadata__geocoder__logradouro":{"description":"Logradouro da coordenada geocodificada.","title":"Prismadata  Geocoder  Logradouro","type":"string"},"prismadata__geocoder__longitude":{"description":"Longitude da coordenada do endereço geocodificado.","title":"Prismadata  Geocoder  Longitude","type":"number"},"prismadata__geocoder__municipio":{"description":"Nome do município em que se encontra a coordenada geocodificada.","title":"Prismadata  Geocoder  Municipio","type":"string"},"prismadata__geocoder__numero":{"description":"Número da coordenada no endereço geocodificado","title":"Prismadata  Geocoder  Numero","type":"integer"},"prismadata__geocoder__score_qualidade_geocodificacao":{"description":"Número que indica o quão confiável é a geocodificação.\n    Varia em uma escala de 0 a 100, onde o valor 100 indica qualdiade máxima.","title":"Prismadata  Geocoder  Score Qualidade Geocodificacao","type":"number"},"prismadata__geocoder__uf":{"description":"Sigla da unidade federativa em que se encontra a coordenada geocodificada.","title":"Prismadata  Geocoder  Uf","type":"string"}},"required":["prismadata__geocoder__cep","prismadata__geocoder__classificacao_qualidade_geocodificacao","prismadata__geocoder__endereco_completo","prismadata__geocoder__latitude","prismadata__geocoder__localidade","prismadata__geocoder__logradouro","prismadata__geocoder__longitude","prismadata__geocoder__municipio","prismadata__geocoder__numero","prismadata__geocoder__score_qualidade_geocodificacao","prismadata__geocoder__uf"],"title":"GeocoderResponse","type":"object"},"example":{"prismadata__geocoder__cep":"30130-165","prismadata__geocoder__classificacao_qualidade_geocodificacao":"MEDIA","prismadata__geocoder__endereco_completo":"RUA ALAGOAS, 686 - SAVASSI, BELO HORIZONTE - MG, 30130-165","prismadata__geocoder__latitude":-19.93292236328125,"prismadata__geocoder__localidade":"SAVASSI","prismadata__geocoder__logradouro":"RUA ALAGOAS","prismadata__geocoder__longitude":-43.935611724853516,"prismadata__geocoder__municipio":"BELO HORIZONTE","prismadata__geocoder__numero":686,"prismadata__geocoder__score_qualidade_geocodificacao":75.0,"prismadata__geocoder__uf":"MG"}}},"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/geocoder?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/geocoder\",\n    params={\"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.geocode(\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$geocode(\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.geocode({\n  fullAddress: \"Av Paulista 1000, Sao Paulo\",\n});\nconsole.log(result);"}]}},"/location/reverse_geocoder":{"get":{"tags":["Geocoder"],"summary":"Geocodificação reversa (coordenada → endereço)","description":"Realiza a geocodificação reversa de um ponto, isto é, retorna o endereço de uma\nlatitude e longitude. Se não for encontrado um endereço próximo ao ponto,\nretorna um objeto vazio.","operationId":"reverse_geocoder_reverse_geocoder_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"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"description":"Modelo com a resposta esperada da API","properties":{"prismadata__reverse_geocoder__cep":{"description":"CEP do endereço mais próximo da coordenada a ser \n    geocodificada reversamente.","title":"Prismadata  Reverse Geocoder  Cep","type":"string"},"prismadata__reverse_geocoder__distancia_m":{"description":"Distância geodésica, em metros, entre a coordenada de entrada \n    e do endereço geocodificado reversamente.","title":"Prismadata  Reverse Geocoder  Distancia M","type":"number"},"prismadata__reverse_geocoder__endereco_completo":{"description":"Endereço completo da coordenada resultante \n    geocodificação reversa.","title":"Prismadata  Reverse Geocoder  Endereco Completo","type":"string"},"prismadata__reverse_geocoder__latitude_endereco":{"description":"Latitude da coordenada do endereço resutltado da\n    geocodificação reversa.","title":"Prismadata  Reverse Geocoder  Latitude Endereco","type":"number"},"prismadata__reverse_geocoder__latitude_input":{"description":"Latitude da coordenada de entrada da \n    geocodificação reversa.","title":"Prismadata  Reverse Geocoder  Latitude Input","type":"number"},"prismadata__reverse_geocoder__localidade":{"description":"Localidade (frequentemente bairro ou região) da coordenada resultante \n    geocodificação reversa.","title":"Prismadata  Reverse Geocoder  Localidade","type":"string"},"prismadata__reverse_geocoder__logradouro":{"description":"Logradouro da coordenada resultante \n    geocodificação reversa.","title":"Prismadata  Reverse Geocoder  Logradouro","type":"string"},"prismadata__reverse_geocoder__longitude_endereco":{"description":"Longitude da coordenada do endereço resutltado da\n    geocodificação reversa.","title":"Prismadata  Reverse Geocoder  Longitude Endereco","type":"number"},"prismadata__reverse_geocoder__longitude_input":{"description":"Longitude da coordenada de entrada da \n    geocodificação reversa.","title":"Prismadata  Reverse Geocoder  Longitude Input","type":"number"},"prismadata__reverse_geocoder__municipio":{"description":"Municipio da coordenada resultante\n    geocodificação reversa.","title":"Prismadata  Reverse Geocoder  Municipio","type":"string"},"prismadata__reverse_geocoder__cod_municipio":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Código IBGE do município (7 dígitos: UF+MUN),\n    derivado do setor censitário CNEFE do endereço mais próximo.\n    Chave canônica para cruzar com renda, CNPJ e denominador\n    municipal (dompp_municipio_batch) do programa Entorno.\n    `null` para os ~2% de endereços sem correção CNEFE-Faces.","title":"Prismadata  Reverse Geocoder  Cod Municipio"},"prismadata__reverse_geocoder__numero":{"description":"Número no logradouro da coordenada resultante \n    geocodificação reversa.","title":"Prismadata  Reverse Geocoder  Numero","type":"integer"},"prismadata__reverse_geocoder__uf":{"description":"Sigla da unidade federativa da coordenada resultante \n    geocodificação reversa.","title":"Prismadata  Reverse Geocoder  Uf","type":"string"}},"required":["prismadata__reverse_geocoder__cep","prismadata__reverse_geocoder__distancia_m","prismadata__reverse_geocoder__endereco_completo","prismadata__reverse_geocoder__latitude_endereco","prismadata__reverse_geocoder__latitude_input","prismadata__reverse_geocoder__localidade","prismadata__reverse_geocoder__logradouro","prismadata__reverse_geocoder__longitude_endereco","prismadata__reverse_geocoder__longitude_input","prismadata__reverse_geocoder__municipio","prismadata__reverse_geocoder__numero","prismadata__reverse_geocoder__uf"],"title":"ReverseGeocoderResponse","type":"object"},"example":{"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__cod_municipio":3304557,"prismadata__reverse_geocoder__numero":516,"prismadata__reverse_geocoder__uf":"RJ"}}},"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/reverse_geocoder?lat=-25.5&lng=-25.5\" \\\n  -H \"X-Apikey: ak_xxxxxxxxxxxxxxxx\""},{"lang":"Python","source":"import httpx\n\nresp = httpx.get(\n    \"https://api.prismadata.io/v1/location/reverse_geocoder\",\n    params={\"lat\": -25.5, \"lng\": -25.5},\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.reverse_geocode(lat=-23.55, lng=-46.63)\nprint(result)"},{"lang":"R SDK","source":"library(prismadata)\n\nclient <- prismadata_client(api_key = \"ak_xxxxxxxxxxxxxxxx\")\nresult <- client$reverse_geocode(lat = -23.55, lng = -46.63)\nprint(result)"},{"lang":"TypeScript SDK","source":"import { PrismaDataClient } from \"prismadata\";\n\nconst client = new PrismaDataClient({ apiKey: \"ak_xxxxxxxxxxxxxxxx\" });\nconst result = await client.reverseGeocode(-23.55, -46.63);\nconsole.log(result);"}]}},"/location/batch/geocoder":{"post":{"tags":["Geocoder"],"summary":"Geocodifica endereços em lote","description":"Endpoint para geocodificacao em batch.\n\nRecebe um dict de ate 512 enderecos indexados por chaves\ndefinidas pelo cliente e retorna as coordenadas de cada um,\npreservando as mesmas chaves na resposta.","operationId":"geocoder_batch_geocoder_batch_post","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":{"properties":{"endereco_completo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endereco Completo","description":"Endereço completo em uma única string."},"cep":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Cep","description":"CEP do endereço."},"numero":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Numero","description":"Número do endereço."},"tipo_logradouro":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tipo Logradouro","description":"Tipo do logradouro. Ex: Rua, Avenida, etc."},"titulo_logradouro":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Titulo Logradouro","description":"Ex: Coronel, Senhor, Senhora, Professor, São, etc."},"logradouro":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logradouro","description":"Logradouro."},"localidade":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Localidade","description":"Localidade do endereço (frequentemente o bairro)."},"municipio":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Municipio","description":"Município."},"estado":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Estado","description":"Unidade Federativa ou Estado do endereço."}},"type":"object","title":"GeocoderBatchItem","description":"Item de input do batch do geocoder. Aceita `endereco_completo` ou\nos campos estruturados do endereço."},"type":"object","description":"Dict indexado por chaves do cliente. Cada valor contém `endereco_completo` ou campos estruturados (`cep`, `numero`, `logradouro`, etc). Até 512 itens por chamada."},"example":{"1":{"endereco_completo":"Rua Alagoas 686, Belo Horizonte MG"},"2":{"cep":"30130-165","numero":601,"logradouro":"Alagoas","municipio":"Belo Horizonte","estado":"MG"}}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"properties":{"prismadata__geocoder__cep":{"type":"string","title":"Prismadata  Geocoder  Cep","description":"CEP da coordenada do endereço geocodificado"},"prismadata__geocoder__cod_setor_cnefe":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prismadata  Geocoder  Cod Setor Cnefe","description":"Código do setor censitário IBGE 2022 (15 dígitos) do\n    endereço geocodificado. `null` para os ~2% de endereços sem\n    correção CNEFE-Faces."},"prismadata__geocoder__classificacao_qualidade_geocodificacao":{"type":"string","enum":["MUITO_ALTA","ALTA","MEDIA","BAIXA","MUITO_BAIXA","CENTROIDE_MUNICIPIO","NAO_GEOCODIFICADO"],"title":"Prismadata  Geocoder  Classificacao Qualidade Geocodificacao","description":"Classe de qualidade da geocodificação, derivada do score (0-100):\n- `MUITO_ALTA` (score 100): endereço localizado com a maior confiança.\n- `ALTA` (score de 90 a menos de 100): endereço localizado com alta confiança.\n- `MEDIA` (score de 50 a menos de 90): localização plausível; vale conferir em usos sensíveis.\n- `BAIXA` (score de 30 a menos de 50): localização incerta; valide antes de usar.\n- `MUITO_BAIXA` (score acima de 0 e abaixo de 30): localização pouco confiável; não use sem validação.\n- `CENTROIDE_MUNICIPIO` (score 5): o endereço não foi localizado, mas o município foi; a coordenada é o centro do município, sem precisão de endereço.\n- `NAO_GEOCODIFICADO` (score 0): não foi possível localizar o endereço (ex.: texto ininteligível); a coordenada não deve ser usada."},"prismadata__geocoder__endereco_completo":{"type":"string","title":"Prismadata  Geocoder  Endereco Completo","description":"Endereço completo da coordenada geocodificada"},"prismadata__geocoder__latitude":{"type":"number","title":"Prismadata  Geocoder  Latitude","description":"Latitude da coordenada do endereço geocodificado."},"prismadata__geocoder__localidade":{"type":"string","title":"Prismadata  Geocoder  Localidade","description":"Nome da localidade da coordenada geocodificada. \n    Frequentemente é o nome do bairro ou da região."},"prismadata__geocoder__logradouro":{"type":"string","title":"Prismadata  Geocoder  Logradouro","description":"Logradouro da coordenada geocodificada."},"prismadata__geocoder__longitude":{"type":"number","title":"Prismadata  Geocoder  Longitude","description":"Longitude da coordenada do endereço geocodificado."},"prismadata__geocoder__municipio":{"type":"string","title":"Prismadata  Geocoder  Municipio","description":"Nome do município em que se encontra a coordenada geocodificada."},"prismadata__geocoder__numero":{"type":"integer","title":"Prismadata  Geocoder  Numero","description":"Número da coordenada no endereço geocodificado"},"prismadata__geocoder__score_qualidade_geocodificacao":{"type":"number","title":"Prismadata  Geocoder  Score Qualidade Geocodificacao","description":"Número que indica o quão confiável é a geocodificação.\n    Varia em uma escala de 0 a 100, onde o valor 100 indica qualdiade máxima."},"prismadata__geocoder__uf":{"type":"string","title":"Prismadata  Geocoder  Uf","description":"Sigla da unidade federativa em que se encontra a coordenada geocodificada."}},"type":"object","required":["prismadata__geocoder__cep","prismadata__geocoder__classificacao_qualidade_geocodificacao","prismadata__geocoder__endereco_completo","prismadata__geocoder__latitude","prismadata__geocoder__localidade","prismadata__geocoder__logradouro","prismadata__geocoder__longitude","prismadata__geocoder__municipio","prismadata__geocoder__numero","prismadata__geocoder__score_qualidade_geocodificacao","prismadata__geocoder__uf"],"title":"GeocoderResponse","description":"Modelo com a resposta esperada da API"},"type":"object","description":"Dict indexado pelas chaves enviadas pelo cliente. Cada valor contém os campos do geocoder com prefixo prismadata__geocoder__.","example":{"1":{"prismadata__geocoder__latitude":-19.93292236328125,"prismadata__geocoder__longitude":-43.935611724853516,"prismadata__geocoder__uf":"MG"}}},"example":{"1":{"prismadata__geocoder__cep":"30130-165","prismadata__geocoder__classificacao_qualidade_geocodificacao":"MUITO_ALTA","prismadata__geocoder__endereco_completo":"RUA ALAGOAS, 686 - SAVASSI, BELO HORIZONTE - MG, 30130-165","prismadata__geocoder__latitude":-19.93292236328125,"prismadata__geocoder__localidade":"SAVASSI","prismadata__geocoder__logradouro":"RUA ALAGOAS","prismadata__geocoder__longitude":-43.935611724853516,"prismadata__geocoder__municipio":"BELO HORIZONTE","prismadata__geocoder__numero":686,"prismadata__geocoder__score_qualidade_geocodificacao":100.0,"prismadata__geocoder__uf":"MG"},"2":{"prismadata__geocoder__cep":"01310-100","prismadata__geocoder__classificacao_qualidade_geocodificacao":"BAIXA","prismadata__geocoder__endereco_completo":"AVENIDA PAULISTA, 960 - BELA VISTA, SAO PAULO - SP, 01310-100","prismadata__geocoder__latitude":-23.56524658203125,"prismadata__geocoder__localidade":"BELA VISTA","prismadata__geocoder__logradouro":"AVENIDA PAULISTA","prismadata__geocoder__longitude":-46.65198516845703,"prismadata__geocoder__municipio":"SAO PAULO","prismadata__geocoder__numero":960,"prismadata__geocoder__score_qualidade_geocodificacao":45.0,"prismadata__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","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/batch/geocoder\" \\\n  -H \"X-Apikey: ak_xxxxxxxxxxxxxxxx\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"1\": {\"endereco_completo\": \"Rua Alagoas 686, Belo Horizonte MG\"}, \"2\": {\"cep\": \"30130-165\", \"numero\": 601, \"logradouro\": \"Alagoas\", \"municipio\": \"Belo Horizonte\", \"estado\": \"MG\"}}'"},{"lang":"Python","source":"import httpx\n\nresp = httpx.post(\n    \"https://api.prismadata.io/v1/location/batch/geocoder\",\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.geocode_batch(addresses={\n    \"p1\": {\"endereco_completo\": \"Av Paulista 1000, Sao Paulo, SP\"},\n    \"p2\": {\"cep\": \"30130-165\", \"numero\": \"100\"},\n})\nprint(result)"}]}},"/location/batch/reverse_geocoder":{"post":{"tags":["Geocoder"],"summary":"Geocodificação reversa em lote","description":"Endpoint para geocodificacao reversa em batch.\n\nRecebe um dict de ate 1024 coordenadas indexadas por chaves\ndefinidas pelo cliente e retorna o endereco mais proximo de cada\numa, preservando as mesmas chaves na resposta.","operationId":"reverse_geocoder_batch_reverse_geocoder_batch_post","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":{"properties":{"lat":{"type":"number","title":"Lat","description":"Latitude WGS84 do ponto."},"lng":{"type":"number","title":"Lng","description":"Longitude WGS84 do ponto."}},"type":"object","required":["lat","lng"],"title":"ReverseGeocoderBatchItem","description":"Item de input do batch do reverse geocoder: uma coordenada."},"type":"object","description":"Dict indexado por chaves do cliente. Cada valor contém `lat` e `lng`. Até 1024 itens por chamada."},"example":{"1":{"lat":-19.932,"lng":-43.938},"2":{"lat":-23.5614,"lng":-46.6559}}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"properties":{"prismadata__reverse_geocoder__cep":{"type":"string","title":"Prismadata  Reverse Geocoder  Cep","description":"CEP do endereço mais próximo da coordenada a ser \n    geocodificada reversamente."},"prismadata__reverse_geocoder__distancia_m":{"type":"number","title":"Prismadata  Reverse Geocoder  Distancia M","description":"Distância geodésica, em metros, entre a coordenada de entrada \n    e do endereço geocodificado reversamente."},"prismadata__reverse_geocoder__endereco_completo":{"type":"string","title":"Prismadata  Reverse Geocoder  Endereco Completo","description":"Endereço completo da coordenada resultante \n    geocodificação reversa."},"prismadata__reverse_geocoder__latitude_endereco":{"type":"number","title":"Prismadata  Reverse Geocoder  Latitude Endereco","description":"Latitude da coordenada do endereço resutltado da\n    geocodificação reversa."},"prismadata__reverse_geocoder__latitude_input":{"type":"number","title":"Prismadata  Reverse Geocoder  Latitude Input","description":"Latitude da coordenada de entrada da \n    geocodificação reversa."},"prismadata__reverse_geocoder__localidade":{"type":"string","title":"Prismadata  Reverse Geocoder  Localidade","description":"Localidade (frequentemente bairro ou região) da coordenada resultante \n    geocodificação reversa."},"prismadata__reverse_geocoder__logradouro":{"type":"string","title":"Prismadata  Reverse Geocoder  Logradouro","description":"Logradouro da coordenada resultante \n    geocodificação reversa."},"prismadata__reverse_geocoder__longitude_endereco":{"type":"number","title":"Prismadata  Reverse Geocoder  Longitude Endereco","description":"Longitude da coordenada do endereço resutltado da\n    geocodificação reversa."},"prismadata__reverse_geocoder__longitude_input":{"type":"number","title":"Prismadata  Reverse Geocoder  Longitude Input","description":"Longitude da coordenada de entrada da \n    geocodificação reversa."},"prismadata__reverse_geocoder__municipio":{"type":"string","title":"Prismadata  Reverse Geocoder  Municipio","description":"Municipio da coordenada resultante\n    geocodificação reversa."},"prismadata__reverse_geocoder__cod_municipio":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Prismadata  Reverse Geocoder  Cod Municipio","description":"Código IBGE do município (7 dígitos: UF+MUN),\n    derivado do setor censitário CNEFE do endereço mais próximo.\n    Chave canônica para cruzar com renda, CNPJ e denominador\n    municipal (dompp_municipio_batch) do programa Entorno.\n    `null` para os ~2% de endereços sem correção CNEFE-Faces."},"prismadata__reverse_geocoder__numero":{"type":"integer","title":"Prismadata  Reverse Geocoder  Numero","description":"Número no logradouro da coordenada resultante \n    geocodificação reversa."},"prismadata__reverse_geocoder__uf":{"type":"string","title":"Prismadata  Reverse Geocoder  Uf","description":"Sigla da unidade federativa da coordenada resultante \n    geocodificação reversa."}},"type":"object","required":["prismadata__reverse_geocoder__cep","prismadata__reverse_geocoder__distancia_m","prismadata__reverse_geocoder__endereco_completo","prismadata__reverse_geocoder__latitude_endereco","prismadata__reverse_geocoder__latitude_input","prismadata__reverse_geocoder__localidade","prismadata__reverse_geocoder__logradouro","prismadata__reverse_geocoder__longitude_endereco","prismadata__reverse_geocoder__longitude_input","prismadata__reverse_geocoder__municipio","prismadata__reverse_geocoder__numero","prismadata__reverse_geocoder__uf"],"title":"ReverseGeocoderResponse","description":"Modelo com a resposta esperada da API"},"type":"object","description":"Dict indexado pelas chaves enviadas pelo cliente. Cada valor contém os campos do reverse geocoder com prefixo prismadata__reverse_geocoder__.","example":{"1":{"prismadata__reverse_geocoder__latitude_input":-19.932,"prismadata__reverse_geocoder__longitude_input":-43.938,"prismadata__reverse_geocoder__distancia_m":48.36}}},"example":{"1":{"prismadata__reverse_geocoder__cep":"30140-010","prismadata__reverse_geocoder__distancia_m":48.35767446,"prismadata__reverse_geocoder__endereco_completo":"PRACA DA LIBERDADE, 450 - SAVASSI, BELO HORIZONTE - MG, 30140-010","prismadata__reverse_geocoder__latitude_endereco":-19.93199348449707,"prismadata__reverse_geocoder__latitude_input":-19.932,"prismadata__reverse_geocoder__localidade":"SAVASSI","prismadata__reverse_geocoder__logradouro":"PRACA DA LIBERDADE","prismadata__reverse_geocoder__longitude_endereco":-43.937538146972656,"prismadata__reverse_geocoder__longitude_input":-43.938,"prismadata__reverse_geocoder__municipio":"BELO HORIZONTE","prismadata__reverse_geocoder__cod_municipio":3106200,"prismadata__reverse_geocoder__numero":450,"prismadata__reverse_geocoder__uf":"MG"},"2":{"prismadata__reverse_geocoder__cep":"01332-030","prismadata__reverse_geocoder__distancia_m":44.69252378,"prismadata__reverse_geocoder__endereco_completo":"RUA CARLOS COMENALE, 241 - BELA VISTA, SAO PAULO - SP, 01332-030","prismadata__reverse_geocoder__latitude_endereco":-23.560596466064453,"prismadata__reverse_geocoder__latitude_input":-23.561,"prismadata__reverse_geocoder__localidade":"BELA VISTA","prismadata__reverse_geocoder__logradouro":"RUA CARLOS COMENALE","prismadata__reverse_geocoder__longitude_endereco":-46.65599822998047,"prismadata__reverse_geocoder__longitude_input":-46.656,"prismadata__reverse_geocoder__municipio":"SAO PAULO","prismadata__reverse_geocoder__cod_municipio":3550308,"prismadata__reverse_geocoder__numero":241,"prismadata__reverse_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","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/batch/reverse_geocoder\" \\\n  -H \"X-Apikey: ak_xxxxxxxxxxxxxxxx\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"1\": {\"lat\": -19.932, \"lng\": -43.938}, \"2\": {\"lat\": -23.5614, \"lng\": -46.6559}}'"},{"lang":"Python","source":"import httpx\n\nresp = httpx.post(\n    \"https://api.prismadata.io/v1/location/batch/reverse_geocoder\",\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.reverse_geocode_batch(points={\n    \"p1\": [-23.55, -46.63],\n    \"p2\": [-22.90, -43.17],\n})\nprint(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":{"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"}}}}