API docs by Redocly

PrismaData Location API (v1)

Download OpenAPI specification:

PrismaData Support Team: suporte.api@prismadata.io URL: https://prismadata.io/contact License: Proprietary Terms of Service

Conjunto de APIs de localização

Favelas

Existem 3 entidades que compõem o dado de favelas: Favelas, complexos e ilhas.

As favelas propriamente ditas que são regiões que são classifcadas 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.

Alé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.

Caso o ponto se encontre distante mais de 5000 metros de uma entidade valores vazios são retornados.

Maiores informações podem ser encontradas na documentação de produto. Testes manuais com o fim de se compreender melhor o dado podem ser feitos aqui.

/slum

Endpoint para consultar a favela mais próxima a determinada coordenada geográfica.

Authorizations:
X-ApikeyX-ApikeyX-ApikeyX-ApikeyX-ApikeyX-Apikey
query Parameters
lat
required
number (Lat) ( -90 .. 90 )
Example: lat=-19.933284645466298

Latitude do ponto de origem.

lng
required
number (Lng) ( -180 .. 180 )
Example: lng=-43.9191946695413

Longitude do ponto de origem.

Api Key (string) or Api Key (null) (Api Key)
Example: api_key=YOUR_TOKEN

Token de acesso à API. Se não for passado como parâmetro na URL deve ser passado no header. Se ainda não possui um token entre em contato.

header Parameters
X-Apikey (string) or X-Apikey (null) (X-Apikey)

Token de acesso via header (opcional se passado como query). Usado para autenticação.Se ainda não possui um token entre em contato.

Responses

Response samples

Content type
application/json
{
  • "prismadata__slum__complexo_area_m2": 1755169.882444958,
  • "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_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_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_perimetro_m": 1992.69,
  • "prismadata__slum__favela_uf": "Minas Gerais",
  • "prismadata__slum__ilha_area_m2": 64746.69,
  • "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"
}

Fronteiras

O dado de fronteiras indica se um ponto está localizado em uma faixa de fronteira e traz algumas informações desta fronteira, como proximidade da fronteira, qual é o país mais próximo e se a mancha urbana do município que o ponto se encontra está próximo da faixa de fronteira.

A faixa de fronteira, segundo o IBGE, é uma faixa de até 150 km de largura ao longo das fronteiras terrestres do Brasil, considerada importante para a defesa nacional. Essa área abrange 16,7% do território brasileiro.

Maiores informações podem ser encontradas na documentação de produto. Testes manuais com o fim de se compreender melhor o dado podem ser feitos aqui.

/border

Endpoint para consultar a proximidade do ponto às fronteiras brasileiras.

Authorizations:
X-ApikeyX-ApikeyX-ApikeyX-ApikeyX-ApikeyX-Apikey
query Parameters
lat
required
number (Lat) ( -90 .. 90 )
Example: lat=-25.52568655357868

Latitude do ponto de consulta.

lng
required
number (Lng) ( -180 .. 180 )
Example: lng=-54.59273323017718

Longitude do ponto de consulta.

Api Key (string) or Api Key (null) (Api Key)
Example: api_key=YOUR_TOKEN

Token de acesso à API. Se não for passado como parâmetro na URL deve ser passado no header. Se ainda não possui um token entre em contato.

header Parameters
X-Apikey (string) or X-Apikey (null) (X-Apikey)

Token de acesso via header (opcional se passado como query). Usado para autenticação.Se ainda não possui um token entre em contato.

Responses

Response samples

Content type
application/json
{
  • "prismadata__border__area_municipio_integrada_faixa_de_fronteira_km2": 609.19,
  • "prismadata__border__area_total_municipio_km2": 609.19,
  • "prismadata__border__distancia_geodesica_pais_mais_proximo_pt_km": 1.112,
  • "prismadata__border__distancia_geodesica_pais_mais_proximo_sede_municipio_km": 1.014,
  • "prismadata__border__distancia_geodesica_ponto_borda_faixa_de_fronteira_km": 0.757,
  • "prismadata__border__muncipio_possui_cidade_gemea": true,
  • "prismadata__border__nome_municipio_de_fronteira": "Foz do Iguaçu",
  • "prismadata__border__pais_mais_proximo": "PARAGUAI",
  • "prismadata__border__pais_mais_proximo_pt": "PARAGUAI",
  • "prismadata__border__ponto_contido_na_faixa_de_fronteira": true,
  • "prismadata__border__porcentagem_area_municipio_faixa_de_fronteira": 100,
  • "prismadata__border__sede_municipio_dentro_da_faixa_de_fronteira": true
}

Validação de Endereços

O validador de endereços consiste em validar um ou mais endereços com um ou mais sinais de localização (frquentemente ibtidos por GPS). Os endereços são comparados com os sinais indicando a condordância ou não da localização do(s) sinal(is) com o(s) endereço(s).

Maiores informações podem ser encontradas na documentação de produto: TODO. Testes manuais com o fim de se compreender melhor o dado podem ser feitos aqui: TODO.

/addr_validation/compare_address

Realiza a comparação de um endereço com determinada coordenada geográfica para avaliar a concordância (proximidade) entre eles.

Authorizations:
X-ApikeyX-ApikeyX-ApikeyX-ApikeyX-ApikeyX-Apikey
query Parameters
lat
required
number (Lat) ( -90 .. 90 )

Latitude do ponto que se deseja realizar a geocodificação reversa

lng
required
number (Lng) ( -180 .. 180 )

Longitude do ponto que se deseja realizar a geocodificação reversa

Endereco Completo (string) or Endereco Completo (null) (Endereco Completo)

Endereço completo a ser a ser geocodificado. Não é necessário informá-lo caso os campos que compõem o endereço sejam fornecidos separadamente

(Cep (Cep (string) or Cep (integer))) or Cep (null) (Cep)
Example: cep=30130-165

CEP do endereço a ser geocodificado.

(Numero (Numero (string) or Numero (integer))) or Numero (null) (Numero)

Numero do endereço a ser geocodificado

Tipo Logradouro (string) or Tipo Logradouro (null) (Tipo Logradouro)

Tipo do logradouro a ser geocodificado.Ex: Rua, Avenida, etc.

Titulo Logradouro (string) or Titulo Logradouro (null) (Titulo Logradouro)

Ex: Coronel, Senhor, Senhora, Professor, São, etc

Logradouro (string) or Logradouro (null) (Logradouro)

O logradouro a ser geocodificado

Localidade (string) or Localidade (null) (Localidade)

Localidade do endereço. Frequentemente a localidade é o bairro ou região do endereço.

Municipio (string) or Municipio (null) (Municipio)

Município do endereço.

Estado (string) or Estado (null) (Estado)

Unidade Federativa ou Estado do endereço.

Api Key (string) or Api Key (null) (Api Key)
Example: api_key=YOUR_TOKEN

Token de acesso à API. Se não for passado como parâmetro na URL deve ser passado no header. Se ainda não possui um token entre em contato.

header Parameters
X-Apikey (string) or X-Apikey (null) (X-Apikey)

Token de acesso via header (opcional se passado como query). Usado para autenticação.Se ainda não possui um token entre em contato.

Responses

Response samples

Content type
application/json
{
  • "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"
}

/addr_validation/validate_location_historic

Valida uma lista de endereços com base no histórico de localização de um dispositivo. A validação indica se cada endereço da lista possui alguma relação com o dispositivo, como "MORADIA", "TRABALHO", "ATIPICO", etc.

Authorizations:
X-ApikeyX-ApikeyX-ApikeyX-ApikeyX-ApikeyX-Apikey
Request Body schema: application/json
required
required
Array of items (Locations) [ items = 3 items ]

Lista de tuplas contendo sinais de localização.

enderecos
required
Array of strings (Enderecos) <= 5 items

Lista de endereços a serem validados

Responses

Request samples

Content type
application/json
{
  • "locations": [
    ],
  • "enderecos": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

/addr_validation/cluster_location_historic

Realiza uma clusterização espacial dos pontos para identificar locais em que os sinais de localização são frequentes ou prolongados. Além disso, com as informações de timestamp classifica em diferentes graus, qual a afinidade do cluster com as seguintes classificações para o centróide do cluster:

  1. MORADIA
  2. TRABALHO
  3. VISITA_FREQUENTE
  4. VISITA_EVENTUAL
Authorizations:
X-ApikeyX-ApikeyX-ApikeyX-ApikeyX-ApikeyX-Apikey
query Parameters
Api Key (string) or Api Key (null) (Api Key)
Example: api_key=YOUR_TOKEN

Token de acesso à API. Se não for passado como parâmetro na URL deve ser passado no header. Se ainda não possui um token entre em contato.

header Parameters
X-Apikey (string) or X-Apikey (null) (X-Apikey)

Token de acesso via header (opcional se passado como query). Usado para autenticação. Se ainda não possui um token entre em contato.

Request Body schema: application/json
required
Array
[0]
number
[1]
number
[2]
number

Responses

Request samples

Content type
application/json
[
  • [
    ]
]

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Geocoder

O Geocoder é o sistema responsável por realizar a conversão de informações de uma localização (textos) em uma coordenada geográfica. Assim, ele converte um endereço para uma latitude/longitude quando opera diretamente. Pode, também, realizar a geocodificação reversa, que consiste em converter uma coordenada geográfica (latitude/longitude) para um endereço.

Maiores informações podem ser encontradas na documentação de produto. Testes manuais com o fim de se compreender melhor o dado podem ser feitos aqui.

/geocoder

Endpoint para se obter a latitude e longitude de um endereço.

Há duas formas de se realizar a geocodificação:

  1. Fornecendo o endereço completo em uma única string (endereco_completo).
  2. Fornecendo os campos do endereço de forma individualizada.

Caso o endereço completo seja fornecido, ele é quebrado nos campos internamente e se os campos forém fornecidos também, estes têm preferência sobre os campos extraídos do endereço completo. Por isso, sugere-se que, se possível, a geocodificação seja feita pelos campos individualizados e não pelo endereço completo.

Authorizations:
X-ApikeyX-ApikeyX-ApikeyX-ApikeyX-ApikeyX-Apikey
query Parameters
Endereco Completo (string) or Endereco Completo (null) (Endereco Completo)

Endereço completo a ser a ser geocodificado. Não é necessário informá-lo caso os campos que compõem o endereço sejam fornecidos separadamente

(Cep (Cep (string) or Cep (integer))) or Cep (null) (Cep)
Example: cep=30130-165

CEP do endereço a ser geocodificado.

(Numero (Numero (string) or Numero (integer))) or Numero (null) (Numero)

Numero do endereço a ser geocodificado

Tipo Logradouro (string) or Tipo Logradouro (null) (Tipo Logradouro)

Tipo do logradouro a ser geocodificado.Ex: Rua, Avenida, etc.

Titulo Logradouro (string) or Titulo Logradouro (null) (Titulo Logradouro)

Ex: Coronel, Senhor, Senhora, Professor, São, etc

Logradouro (string) or Logradouro (null) (Logradouro)

O logradouro a ser geocodificado

Localidade (string) or Localidade (null) (Localidade)

Localidade do endereço. Frequentemente a localidade é o Bairro do endereço

Municipio (string) or Municipio (null) (Municipio)

Município do endereço

Estado (string) or Estado (null) (Estado)

Unidade Federativa ou Estado do endereço

Api Key (string) or Api Key (null) (Api Key)
Example: api_key=YOUR_TOKEN

Token de acesso à API. Se não for passado como parâmetro na URL deve ser passado no header. Se ainda não possui um token entre em contato.

header Parameters
X-Apikey (string) or X-Apikey (null) (X-Apikey)

Token de acesso via header (opcional se passado como query). Usado para autenticação.Se ainda não possui um token entre em contato.

Responses

Response samples

Content type
application/json
{
  • "prismadata__geocoder__cep": "30130-165",
  • "prismadata__geocoder__classificao_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,
  • "prismadata__geocoder__uf": "MG"
}

/reverse_geocoder

Realiza a geocodificação reversa de um ponto, isto é, retorna o endereço de uma latitude e longitude. Se não for encontrado um endereço a no máximo 100 metros do ponto, não é realizada a geocodificação reversa e um HTTP 404 é retornado.

Authorizations:
X-ApikeyX-ApikeyX-ApikeyX-ApikeyX-ApikeyX-Apikey
query Parameters
lat
required
number (Lat) ( -90 .. 90 )

Latitude do ponto que se deseja realizar a geocodificação reversa

lng
required
number (Lng) ( -180 .. 180 )

Longitude do ponto que se deseja realizar a geocodificação reversa

Api Key (string) or Api Key (null) (Api Key)
Example: api_key=YOUR_TOKEN

Token de acesso à API. Se não for passado como parâmetro na URL deve ser passado no header. Se ainda não possui um token entre em contato.

header Parameters
X-Apikey (string) or X-Apikey (null) (X-Apikey)

Token de acesso via header (opcional se passado como query). Usado para autenticação.Se ainda não possui um token entre em contato.

Responses

Response samples

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

Renda

A API de renda fornece estimativas da renda na região próxima de determinada coordenada geográfica. Veja que esta informação de renda não se refere à uma pessoa específica, mas sim a uma região em que ela mora ou se encontra em determinado momento.

Se a coordenada geográfica de entrada (latitude/longitude) não for localizada no Brasil, valores nulos serão retornados.

Maiores informações podem ser encontradas na documentação de produto:

  1. Renda Pessoal Estática
  2. Renda Pessoal Dinâmica (PDF)

Testes manuais com o fim de se compreender melhor o dado podem ser feitos aqui.

/personal_income_static

Endpoint para se consultar o endereço mais próximo à uma coordenada geográfica (latitude/longitude). Caso a coordenada não possua nenhum endereço próximo à vizinhança de 100 metros, valores nulos são retornados.

Authorizations:
X-ApikeyX-ApikeyX-ApikeyX-ApikeyX-ApikeyX-Apikey
query Parameters
lat
required
number (Lat) ( -90 .. 90 )
Example: lat=-19.932378368680315

Latitude do ponto a ser estudado.

lng
required
number (Lng) ( -180 .. 180 )
Example: lng=-43.9351245162891

Longitude do ponto a ser estudado.

Api Key (string) or Api Key (null) (Api Key)
Example: api_key=YOUR_TOKEN

Token de acesso à API. Se não for passado como parâmetro na URL deve ser passado no header. Se ainda não possui um token entre em contato.

header Parameters
X-Apikey (string) or X-Apikey (null) (X-Apikey)

Token de acesso via header (opcional se passado como query). Usado para autenticação.Se ainda não possui um token entre em contato.

Responses

Response samples

Content type
application/json
{
  • "prismadata__personal_income_static__faixa_sm": "5_A_10_SM",
  • "prismadata__personal_income_static__percentil_br": 98,
  • "prismadata__personal_income_static__percentil_mun": 90,
  • "prismadata__personal_income_static__percentil_uf": 99
}

/personal_income_pdf

Endpoint para se consultar a renda na coordenada geográfica. As informações retornadas são gerados por um modelo que é uma função de densidade de probabilidade (Probability Denstity Funciont -PDF). Opcionalmente, pode-se definir um perfil detalhado do indivíduo que se deseja estimar a renda.

Authorizations:
X-ApikeyX-ApikeyX-ApikeyX-ApikeyX-ApikeyX-Apikey
query Parameters
lat
required
number (Lat) ( -90 .. 90 )
Example: lat=-19.932378368680315

Latitude do ponto de origem.

lng
required
number (Lng) ( -180 .. 180 )
Example: lng=-43.9351245162891

Longitude do ponto de origem

Genero (string) or Gender (null) (Gender)
Example: gender=M

Gênero da pessoa que se deseja analisar a renda. [M, F]

Age (number) or Age (null) (Age)
Example: age=50

Idade da pessoa que se deseja analisar a renda

AtributosBooleanos (string) or Is Responsible (null) (Is Responsible)
Example: is_responsible=false

Indicador se as pessoas que se deseja analisar a renda são responsáveis pelo domicílio

Income Compared (number) or Income Compared (null) (Income Compared)
Example: income_compared=10000

Renda a ser comparada com a renda da região.

Api Key (string) or Api Key (null) (Api Key)
Example: api_key=YOUR_TOKEN

Token de acesso à API. Se não for passado como parâmetro na URL deve ser passado no header. Se ainda não possui um token entre em contato.

Date Income (string) or Date Income (null) (Date Income)
Example: date_income=2025-01-25

Data a ser consultada a renda no formato YYYY-MM-DD. Somente datas após 2022-01-01 são válidas.

header Parameters
X-Apikey (string) or X-Apikey (null) (X-Apikey)

Token de acesso via header (opcional se passado como query). Usado para autenticação.Se ainda não possui um token entre em contato.

Responses

Response samples

Content type
application/json
{
  • "prismadata__personal_income_pdf__qtde_pessoas": 475,
  • "prismadata__personal_income_pdf__qtde_pessoas_sem_renda": 61,
  • "prismadata__personal_income_pdf__renda_comparada_cdf": 69.58161423037396,
  • "prismadata__personal_income_pdf__renda_comparada_pdf": 0.00004347742504677703,
  • "prismadata__personal_income_pdf__renda_comparada_z_score": 0.5124048241824011,
  • "prismadata__personal_income_pdf__renda_media_pessoas": 7977.094543374305,
  • "prismadata__personal_income_pdf__renda_pessoas_com_renda_desvio_padrao": 8734.869682287694,
  • "prismadata__personal_income_pdf__renda_pessoas_com_renda_maxima": 61487.85959498082,
  • "prismadata__personal_income_pdf__renda_pessoas_com_renda_media": 9152.463546142017,
  • "prismadata__personal_income_pdf__renda_pessoas_com_renda_mediana": 6781.762582549223,
  • "prismadata__personal_income_pdf__renda_pessoas_com_renda_minima": 697.1449013796515,
  • "prismadata__personal_income_pdf__renda_pessoas_com_renda_primeiro_quartil": 3582.7074159885547,
  • "prismadata__personal_income_pdf__renda_pessoas_com_renda_qtde": 414,
  • "prismadata__personal_income_pdf__renda_pessoas_com_renda_terceiro_quartil": 11412.45045466984,
  • "prismadata__personal_income_pdf__renda_total": 3789119.908102795,
  • "prismadata__personal_income_pdf__renda_total_m2": 95.5377576127026
}

InfoSC

O dado de informações do setor censitário retorna, a partir de uma coordenada geográfica, as informações básicas acerca da proximidade do ponto.

Maiores informações podem ser encontradas na documentação de produto. Testes manuais com o fim de se compreender melhor o dado podem ser feitos aqui.

/infosc

Busca as informações da região que o ponto se encontra

Authorizations:
X-ApikeyX-ApikeyX-ApikeyX-ApikeyX-ApikeyX-Apikey
query Parameters
lat
required
number (Lat) ( -90 .. 90 )

Latitude do ponto que se deseja realizar a geocodificação reversa

lng
required
number (Lng) ( -180 .. 180 )

Longitude do ponto que se deseja realizar a geocodificação reversa

Api Key (string) or Api Key (null) (Api Key)
Example: api_key=YOUR_TOKEN

Token de acesso à API. Se não for passado como parâmetro na URL deve ser passado no header. Se ainda não possui um token entre em contato.

header Parameters
X-Apikey (string) or X-Apikey (null) (X-Apikey)

Token de acesso via header (opcional se passado como query). Usado para autenticação.Se ainda não possui um token entre em contato.

Responses

Response samples

Content type
application/json
{
  • "prismadata__infosc__area_km2": 0.140840328651949,
  • "prismadata__infosc__municipio": "Ribeirão Pires",
  • "prismadata__infosc__regiao": "Sudeste",
  • "prismadata__infosc__situacao": "Urbana",
  • "prismadata__infosc__tipo_sc": "NAO_ESPECIAL",
  • "prismadata__infosc__tipo_situacao": "AREA_URBANA_ALTA_DENSIDADE",
  • "prismadata__infosc__uf": "São Paulo"
}

/batch/infosc

Busca as informações dos setores censitários em lote. A cobrança desta api é feita em função do número de coordenadas contidas no lote.

Authorizations:
X-ApikeyX-ApikeyX-ApikeyX-ApikeyX-ApikeyX-Apikey
query Parameters
Api Key (string) or Api Key (null) (Api Key)
Example: api_key=YOUR_TOKEN

Token de acesso à API. Se não for passado como parâmetro na URL deve ser passado no header. Se ainda não possui um token entre em contato.

header Parameters
X-Apikey (string) or X-Apikey (null) (X-Apikey)

Token de acesso via header (opcional se passado como query). Usado para autenticação.Se ainda não possui um token entre em contato.

Request Body schema: application/json
required
<= 1024 properties
property name*
additional property
Array of numbers (Coordinates) = 2 items

Lista de [latitude, longitude]

Responses

Request samples

Content type
application/json
{
  • "point1": [
    ],
  • "point2": [
    ]
}

Response samples

Content type
application/json
{
  • "1": {
    },
  • "2": {
    }
}