{"openapi":"3.1.0","info":{"title":"PrismaData — Favelas","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":"Existem 3 entidades que compõem o dado de favelas: Favelas, complexos e ilhas.\n\nAs favelas propriamente ditas que são regiões que são classificadas desta forma pelo IBGE em função das características construtivas do domicílios contidos nesta região. Note que favelas, em conjunto, quando se encontram próximas, podem formar complexos de favelas.\n\nAlém disso, é possível a existência de regiões dentro de favelas ou complexos nas quais os aspectos construtivos dos domicílios não se enquadram dentro do conceito do IBGE para que um domicílio seja considerado de favela, contudo são regiões que estão cercadas por regiões de favela. Neste caso, denominou-se esta região de ilha, já que ela se encontra rodeada por favela apesar dela própria não ser uma região de favela. Frequentemente as ilhas, são regiões que contêm domicilios de conjuntos habitacionais.\n\nCaso o ponto se encontre distante mais de 5000 metros de uma entidade valores vazios são retornados.\n\nMaiores informações podem ser encontradas na [documentação de produto](https://prismadata.io/doc-comercial/favelas/). Testes manuais com o fim de se 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":"Favelas","description":"Existem 3 entidades que compõem o dado de favelas: Favelas, complexos e ilhas.\n\nAs favelas propriamente ditas que são regiões que são classificadas desta forma pelo IBGE em função das características construtivas do domicílios contidos nesta região. Note que favelas, em conjunto, quando se encontram próximas, podem formar complexos de favelas.\n\nAlém disso, é possível a existência de regiões dentro de favelas ou complexos nas quais os aspectos construtivos dos domicílios não se enquadram dentro do conceito do IBGE para que um domicílio seja considerado de favela, contudo são regiões que estão cercadas por regiões de favela. Neste caso, denominou-se esta região de ilha, já que ela se encontra rodeada por favela apesar dela própria não ser uma região de favela. Frequentemente as ilhas, são regiões que contêm domicilios de conjuntos habitacionais.\n\nCaso o ponto se encontre distante mais de 5000 metros de uma entidade valores vazios são retornados.\n\nMaiores informações podem ser encontradas na [documentação de produto](https://prismadata.io/doc-comercial/favelas/). Testes manuais com o fim de se compreender melhor o dado podem ser feitos [aqui](https://prismadata.io/testador-de-api/api-de-localizacao/).\n"}],"paths":{"/location/batch/slum":{"post":{"tags":["Favelas"],"summary":"Favela mais próxima em lote","description":"Busca as informações de favelas em lote. A cobrança desta api é feita em\nfunção do número de coordenadas contidas no lote.","operationId":"slum_batch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationDict"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"properties":{"prismadata__slum__complexo_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Prismadata  Slum  Complexo Area M2","description":"tamanho da área em metros quadrados do complexo mais próximo ao ponto."},"prismadata__slum__complexo_contido":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Prismadata  Slum  Complexo Contido","description":"indica se o ponto consultado está contido na geometria do complexo mais próximo. `true` quando o ponto cai dentro do complexo, `false` quando está fora."},"prismadata__slum__complexo_distancia_centroid_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Prismadata  Slum  Complexo Distancia Centroid M","description":"a distância em metros do ponto até o miolo, ou ponto central do complexo."},"prismadata__slum__complexo_distancia_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Prismadata  Slum  Complexo Distancia M","description":"a distância em metros do ponto até a borda do complexo. Se o valor for negativo, o ponto se encontra dentro do complexo. Se for positivo, se encontra fora do complexo de favelas."},"prismadata__slum__complexo_dompp_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Prismadata  Slum  Complexo Dompp Total","description":"número total de domicílios particulares permanentes que estão contidos no complexo mais próximo ao ponto."},"prismadata__slum__complexo_hash_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Prismadata  Slum  Complexo Hash Id","description":"id que identifica unicamente o complexo."},"prismadata__slum__complexo_municipio":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prismadata  Slum  Complexo Municipio","description":"nome do município em que se encontra o complexo."},"prismadata__slum__complexo_nome":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prismadata  Slum  Complexo Nome","description":"nome do complexo de favelas conforme cadastro do IBGE (ex.: 'Complexo do Alemão'). Nulo quando não há complexo no raio de busca ou quando o cadastro não traz nome."},"prismadata__slum__complexo_perimetro_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Prismadata  Slum  Complexo Perimetro M","description":"o perimetro em metros da geometria que define o complexo de favelas."},"prismadata__slum__complexo_total_favelas":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Prismadata  Slum  Complexo Total Favelas","description":"quantidade de favelas que formam o complexo de favelas."},"prismadata__slum__complexo_uf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prismadata  Slum  Complexo Uf","description":"Unidade Federativa em que se encontra o complexo."},"prismadata__slum__favela_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Prismadata  Slum  Favela Area M2","description":"tamanho da área em metros quadrados da favela mais próxima ao ponto."},"prismadata__slum__favela_contido":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Prismadata  Slum  Favela Contido","description":"indica se o ponto consultado está contido na geometria da favela mais próxima. `true` quando o ponto cai dentro da favela, `false` quando está fora."},"prismadata__slum__favela_distancia_centroid_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Prismadata  Slum  Favela Distancia Centroid M","description":"distância em metros que o ponto se encontra do miolo ou ponto central da favela mais próxima à ele."},"prismadata__slum__favela_distancia_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Prismadata  Slum  Favela Distancia M","description":"a distância em metros à fronteira da favela. Valores positivos indicam um ponto fora da favela e valores negativos indicam um ponto dentro dos limites da favela."},"prismadata__slum__favela_dompp_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Prismadata  Slum  Favela Dompp Total","description":"quantidade de domicílios particulares permanentes da favela mais próxima ao ponto."},"prismadata__slum__favela_hash_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Prismadata  Slum  Favela Hash Id","description":"identificador que identifica unicamente a favela."},"prismadata__slum__favela_municipio":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prismadata  Slum  Favela Municipio","description":"nome do município em que se encontra a favela mais próxima ao ponto."},"prismadata__slum__favela_nome":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prismadata  Slum  Favela Nome","description":"nome da favela conforme cadastro do IBGE. Nulo quando não há favela no raio de busca ou quando o cadastro não traz nome."},"prismadata__slum__favela_perimetro_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Prismadata  Slum  Favela Perimetro M","description":"o perímetro em metros da geometria que define os limites da favela."},"prismadata__slum__favela_uf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prismadata  Slum  Favela Uf","description":"Unidade Federativa em que se encontra a favela."},"prismadata__slum__ilha_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Prismadata  Slum  Ilha Area M2","description":"área em metros quadrados da ilha mais próxima ao ponto."},"prismadata__slum__ilha_contido":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Prismadata  Slum  Ilha Contido","description":"indica se o ponto consultado está contido na geometria da ilha mais próxima. `true` quando o ponto cai dentro da ilha, `false` quando está fora."},"prismadata__slum__ilha_distancia_centroid_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Prismadata  Slum  Ilha Distancia Centroid M","description":"distância do ponto ao centroid da ilha mais próxima à ele."},"prismadata__slum__ilha_distancia_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Prismadata  Slum  Ilha Distancia M","description":"distância do ponto à borda da ilha mais próxima à ele. Valores positivos indicam um ponto contido fora dos limites da ilha, enquanto valores negativos indicam o ponto contido dentro dos limites da ilha."},"prismadata__slum__ilha_hash_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Prismadata  Slum  Ilha Hash Id","description":"valor que identifica unicamente a ilha mais proxima ao ponto."},"prismadata__slum__ilha_perimetro_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Prismadata  Slum  Ilha Perimetro M","description":"o perimetro em metros da geometria de delimita a ilha mais próxima ao ponto."},"prismadata__slum__ilha_tipo_geom_contenedora":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prismadata  Slum  Ilha Tipo Geom Contenedora","description":"indica se a ilha está contida em uma favela ou em um complexo de favelas."}},"type":"object","required":["prismadata__slum__complexo_area_m2","prismadata__slum__complexo_contido","prismadata__slum__complexo_distancia_centroid_m","prismadata__slum__complexo_distancia_m","prismadata__slum__complexo_dompp_total","prismadata__slum__complexo_hash_id","prismadata__slum__complexo_municipio","prismadata__slum__complexo_nome","prismadata__slum__complexo_perimetro_m","prismadata__slum__complexo_total_favelas","prismadata__slum__complexo_uf","prismadata__slum__favela_area_m2","prismadata__slum__favela_contido","prismadata__slum__favela_distancia_centroid_m","prismadata__slum__favela_distancia_m","prismadata__slum__favela_dompp_total","prismadata__slum__favela_hash_id","prismadata__slum__favela_municipio","prismadata__slum__favela_nome","prismadata__slum__favela_perimetro_m","prismadata__slum__favela_uf","prismadata__slum__ilha_area_m2","prismadata__slum__ilha_contido","prismadata__slum__ilha_distancia_centroid_m","prismadata__slum__ilha_distancia_m","prismadata__slum__ilha_hash_id","prismadata__slum__ilha_perimetro_m","prismadata__slum__ilha_tipo_geom_contenedora"],"title":"SlumResponse","description":"Modelo com a resposta esperada da API.\n\nFavela, complexo e ilha são buscados de forma independente, cada um\nlimitado a um raio de `max_dist` metros (5.000 por padrão). Quando não há\nentidade de um tipo dentro desse raio, **todos** os campos daquele tipo\nvoltam nulos — a chave continua presente na resposta, só o valor é `null`.\n\nIsso vale para os três prefixos, inclusive `favela_*`: um ponto rural\ndistante de qualquer favela devolve as 28 chaves com valor nulo. Por isso\ntodo campo é obrigatório (sempre presente) porém anulável."},"type":"object","title":"BatchSlumResponse","description":"Resultados por ponto. A chave é o ID do ponto enviado na requisição,\necoado tal e qual, e o valor tem o mesmo formato do endpoint de ponto\núnico."},"example":{"1":{"prismadata__slum__complexo_area_m2":1755169.882444958,"prismadata__slum__complexo_contido":false,"prismadata__slum__complexo_distancia_centroid_m":847.28,"prismadata__slum__complexo_distancia_m":132.96,"prismadata__slum__complexo_dompp_total":13901,"prismadata__slum__complexo_hash_id":6146791748692800000,"prismadata__slum__complexo_municipio":"Belo Horizonte","prismadata__slum__complexo_nome":"Marçola","prismadata__slum__complexo_perimetro_m":10054.86267269001,"prismadata__slum__complexo_total_favelas":9,"prismadata__slum__complexo_uf":"Minas Gerais","prismadata__slum__favela_area_m2":114306.97,"prismadata__slum__favela_contido":false,"prismadata__slum__favela_distancia_centroid_m":280.37,"prismadata__slum__favela_distancia_m":132.96,"prismadata__slum__favela_dompp_total":1394,"prismadata__slum__favela_hash_id":6476692552498676000,"prismadata__slum__favela_municipio":"Belo Horizonte","prismadata__slum__favela_nome":"Nossa Senhora da Aparecida","prismadata__slum__favela_perimetro_m":1992.69,"prismadata__slum__favela_uf":"Minas Gerais","prismadata__slum__ilha_area_m2":64746.69,"prismadata__slum__ilha_contido":false,"prismadata__slum__ilha_distancia_centroid_m":1527.42,"prismadata__slum__ilha_distancia_m":1369.38,"prismadata__slum__ilha_hash_id":-3871855200304948700,"prismadata__slum__ilha_perimetro_m":1772.35,"prismadata__slum__ilha_tipo_geom_contenedora":"COMPLEXO"}}}},"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/batch/slum\" \\\n  -H \"X-Apikey: ak_xxxxxxxxxxxxxxxx\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"1\": [-23.55, -46.63], \"2\": [-22.90, -43.17]}'"},{"lang":"Python","source":"import httpx\n\nresp = httpx.post(\n    \"https://api.prismadata.io/v1/location/batch/slum\",\n    json={\"1\": [-23.55, -46.63], \"2\": [-22.90, -43.17]},\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.slum_batch(points={\n    \"p1\": [-23.55, -46.63],\n    \"p2\": [-22.90, -43.17],\n})\nprint(result)"},{"lang":"R SDK","source":"library(prismadata)\n\nclient <- prismadata_client(api_key = \"ak_xxxxxxxxxxxxxxxx\")\npoints <- list(\n  \"p1\" = c(-23.5505, -46.6333),\n  \"p2\" = c(-22.9068, -43.1729),\n  \"p3\" = c(-15.7942, -47.8822)\n)\n\nresults <- client$slum_batch(points = points)\nprint(results)"},{"lang":"TypeScript SDK","source":"import { PrismaDataClient } from \"prismadata\";\n\nconst client = new PrismaDataClient({ apiKey: \"ak_xxxxxxxxxxxxxxxx\" });\nconst result = await client.slumBatch({\n  p1: [-23.55, -46.63],\n  p2: [-22.90, -43.17],\n});\nconsole.log(result);"}]}},"/location/slum":{"get":{"tags":["Favelas"],"summary":"Favela mais próxima de uma coordenada","description":"Endpoint para consultar a favela mais próxima a determinada coordenada\ngeográfica.","operationId":"slum_query","parameters":[{"name":"lat","in":"query","required":true,"schema":{"type":"number","exclusiveMaximum":90.0,"exclusiveMinimum":-90.0,"description":"Latitude do ponto de origem.","title":"Lat"},"description":"Latitude do ponto de origem.","example":-19.933284645466298},{"name":"lng","in":"query","required":true,"schema":{"type":"number","exclusiveMaximum":180.0,"exclusiveMinimum":-180.0,"description":"Longitude do ponto de origem.","title":"Lng"},"description":"Longitude do ponto de origem.","example":-43.9191946695413}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"description":"Modelo com a resposta esperada da API.\n\nFavela, complexo e ilha são buscados de forma independente, cada um\nlimitado a um raio de `max_dist` metros (5.000 por padrão). Quando não há\nentidade de um tipo dentro desse raio, **todos** os campos daquele tipo\nvoltam nulos — a chave continua presente na resposta, só o valor é `null`.\n\nIsso vale para os três prefixos, inclusive `favela_*`: um ponto rural\ndistante de qualquer favela devolve as 28 chaves com valor nulo. Por isso\ntodo campo é obrigatório (sempre presente) porém anulável.","properties":{"prismadata__slum__complexo_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"tamanho da área em metros quadrados do complexo mais próximo ao ponto.","title":"Prismadata  Slum  Complexo Area M2"},"prismadata__slum__complexo_contido":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"indica se o ponto consultado está contido na geometria do complexo mais próximo. `true` quando o ponto cai dentro do complexo, `false` quando está fora.","title":"Prismadata  Slum  Complexo Contido"},"prismadata__slum__complexo_distancia_centroid_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"a distância em metros do ponto até o miolo, ou ponto central do complexo.","title":"Prismadata  Slum  Complexo Distancia Centroid M"},"prismadata__slum__complexo_distancia_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"a distância em metros do ponto até a borda do complexo. Se o valor for negativo, o ponto se encontra dentro do complexo. Se for positivo, se encontra fora do complexo de favelas.","title":"Prismadata  Slum  Complexo Distancia M"},"prismadata__slum__complexo_dompp_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"número total de domicílios particulares permanentes que estão contidos no complexo mais próximo ao ponto.","title":"Prismadata  Slum  Complexo Dompp Total"},"prismadata__slum__complexo_hash_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"id que identifica unicamente o complexo.","title":"Prismadata  Slum  Complexo Hash Id"},"prismadata__slum__complexo_municipio":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"nome do município em que se encontra o complexo.","title":"Prismadata  Slum  Complexo Municipio"},"prismadata__slum__complexo_nome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"nome do complexo de favelas conforme cadastro do IBGE (ex.: 'Complexo do Alemão'). Nulo quando não há complexo no raio de busca ou quando o cadastro não traz nome.","title":"Prismadata  Slum  Complexo Nome"},"prismadata__slum__complexo_perimetro_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"o perimetro em metros da geometria que define o complexo de favelas.","title":"Prismadata  Slum  Complexo Perimetro M"},"prismadata__slum__complexo_total_favelas":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"quantidade de favelas que formam o complexo de favelas.","title":"Prismadata  Slum  Complexo Total Favelas"},"prismadata__slum__complexo_uf":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unidade Federativa em que se encontra o complexo.","title":"Prismadata  Slum  Complexo Uf"},"prismadata__slum__favela_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"tamanho da área em metros quadrados da favela mais próxima ao ponto.","title":"Prismadata  Slum  Favela Area M2"},"prismadata__slum__favela_contido":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"indica se o ponto consultado está contido na geometria da favela mais próxima. `true` quando o ponto cai dentro da favela, `false` quando está fora.","title":"Prismadata  Slum  Favela Contido"},"prismadata__slum__favela_distancia_centroid_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"distância em metros que o ponto se encontra do miolo ou ponto central da favela mais próxima à ele.","title":"Prismadata  Slum  Favela Distancia Centroid M"},"prismadata__slum__favela_distancia_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"a distância em metros à fronteira da favela. Valores positivos indicam um ponto fora da favela e valores negativos indicam um ponto dentro dos limites da favela.","title":"Prismadata  Slum  Favela Distancia M"},"prismadata__slum__favela_dompp_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"quantidade de domicílios particulares permanentes da favela mais próxima ao ponto.","title":"Prismadata  Slum  Favela Dompp Total"},"prismadata__slum__favela_hash_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"identificador que identifica unicamente a favela.","title":"Prismadata  Slum  Favela Hash Id"},"prismadata__slum__favela_municipio":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"nome do município em que se encontra a favela mais próxima ao ponto.","title":"Prismadata  Slum  Favela Municipio"},"prismadata__slum__favela_nome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"nome da favela conforme cadastro do IBGE. Nulo quando não há favela no raio de busca ou quando o cadastro não traz nome.","title":"Prismadata  Slum  Favela Nome"},"prismadata__slum__favela_perimetro_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"o perímetro em metros da geometria que define os limites da favela.","title":"Prismadata  Slum  Favela Perimetro M"},"prismadata__slum__favela_uf":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unidade Federativa em que se encontra a favela.","title":"Prismadata  Slum  Favela Uf"},"prismadata__slum__ilha_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"área em metros quadrados da ilha mais próxima ao ponto.","title":"Prismadata  Slum  Ilha Area M2"},"prismadata__slum__ilha_contido":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"indica se o ponto consultado está contido na geometria da ilha mais próxima. `true` quando o ponto cai dentro da ilha, `false` quando está fora.","title":"Prismadata  Slum  Ilha Contido"},"prismadata__slum__ilha_distancia_centroid_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"distância do ponto ao centroid da ilha mais próxima à ele.","title":"Prismadata  Slum  Ilha Distancia Centroid M"},"prismadata__slum__ilha_distancia_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"distância do ponto à borda da ilha mais próxima à ele. Valores positivos indicam um ponto contido fora dos limites da ilha, enquanto valores negativos indicam o ponto contido dentro dos limites da ilha.","title":"Prismadata  Slum  Ilha Distancia M"},"prismadata__slum__ilha_hash_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"valor que identifica unicamente a ilha mais proxima ao ponto.","title":"Prismadata  Slum  Ilha Hash Id"},"prismadata__slum__ilha_perimetro_m":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"o perimetro em metros da geometria de delimita a ilha mais próxima ao ponto.","title":"Prismadata  Slum  Ilha Perimetro M"},"prismadata__slum__ilha_tipo_geom_contenedora":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"indica se a ilha está contida em uma favela ou em um complexo de favelas.","title":"Prismadata  Slum  Ilha Tipo Geom Contenedora"}},"required":["prismadata__slum__complexo_area_m2","prismadata__slum__complexo_contido","prismadata__slum__complexo_distancia_centroid_m","prismadata__slum__complexo_distancia_m","prismadata__slum__complexo_dompp_total","prismadata__slum__complexo_hash_id","prismadata__slum__complexo_municipio","prismadata__slum__complexo_nome","prismadata__slum__complexo_perimetro_m","prismadata__slum__complexo_total_favelas","prismadata__slum__complexo_uf","prismadata__slum__favela_area_m2","prismadata__slum__favela_contido","prismadata__slum__favela_distancia_centroid_m","prismadata__slum__favela_distancia_m","prismadata__slum__favela_dompp_total","prismadata__slum__favela_hash_id","prismadata__slum__favela_municipio","prismadata__slum__favela_nome","prismadata__slum__favela_perimetro_m","prismadata__slum__favela_uf","prismadata__slum__ilha_area_m2","prismadata__slum__ilha_contido","prismadata__slum__ilha_distancia_centroid_m","prismadata__slum__ilha_distancia_m","prismadata__slum__ilha_hash_id","prismadata__slum__ilha_perimetro_m","prismadata__slum__ilha_tipo_geom_contenedora"],"title":"SlumResponse","type":"object"},"example":{"prismadata__slum__complexo_area_m2":1755169.882444958,"prismadata__slum__complexo_contido":false,"prismadata__slum__complexo_distancia_centroid_m":847.28,"prismadata__slum__complexo_distancia_m":132.96,"prismadata__slum__complexo_dompp_total":13901,"prismadata__slum__complexo_hash_id":6146791748692800000,"prismadata__slum__complexo_municipio":"Belo Horizonte","prismadata__slum__complexo_nome":"Marçola","prismadata__slum__complexo_perimetro_m":10054.86267269001,"prismadata__slum__complexo_total_favelas":9,"prismadata__slum__complexo_uf":"Minas Gerais","prismadata__slum__favela_area_m2":114306.97,"prismadata__slum__favela_contido":false,"prismadata__slum__favela_distancia_centroid_m":280.37,"prismadata__slum__favela_distancia_m":132.96,"prismadata__slum__favela_dompp_total":1394,"prismadata__slum__favela_hash_id":6476692552498676000,"prismadata__slum__favela_municipio":"Belo Horizonte","prismadata__slum__favela_nome":"Nossa Senhora da Aparecida","prismadata__slum__favela_perimetro_m":1992.69,"prismadata__slum__favela_uf":"Minas Gerais","prismadata__slum__ilha_area_m2":64746.69,"prismadata__slum__ilha_contido":false,"prismadata__slum__ilha_distancia_centroid_m":1527.42,"prismadata__slum__ilha_distancia_m":1369.38,"prismadata__slum__ilha_hash_id":-3871855200304948700,"prismadata__slum__ilha_perimetro_m":1772.35,"prismadata__slum__ilha_tipo_geom_contenedora":"COMPLEXO"}}},"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/slum?lat=-19.933284645466298&lng=-43.9191946695413\" \\\n  -H \"X-Apikey: ak_xxxxxxxxxxxxxxxx\""},{"lang":"Python","source":"import httpx\n\nresp = httpx.get(\n    \"https://api.prismadata.io/v1/location/slum\",\n    params={\"lat\": -19.933284645466298, \"lng\": -43.9191946695413},\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.slum(lat=-23.55, lng=-46.63)\nprint(result)"},{"lang":"R SDK","source":"library(prismadata)\n\nclient <- prismadata_client(api_key = \"ak_xxxxxxxxxxxxxxxx\")\nresult <- client$slum(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.slum(-23.55, -46.63);\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":{"Coordinates":{"items":{"type":"number"},"type":"array","maxItems":2,"minItems":2,"title":"Coordinates","description":"Encapsula as coordenadas geográficas","example":[-23.5505,-46.6333]},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"LocationDict":{"additionalProperties":{"$ref":"#/components/schemas/Coordinates"},"type":"object","maxProperties":1024,"title":"LocationDict","description":"Modelo da entrada em batch","example":{"point1":[-23.5505,-46.6333],"point2":[40.7128,-74.006]}},"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"}}}}