Pesquisas

As pesquisas providas por este serviço são um subconjunto da API de Agregados

Indicadores por pesquisa

Funcionalmente igual à consulta /pesquisas/{pesquisa}/periodos/all/indicadores/{posicao}

Pesquisa

Funcionalmente igual à consulta /pesquisas/{pesquisa}/periodos/all/indicadores/{posicao}

URL Base: https://servicodados.ibge.gov.br/api/v1/pesquisas

Endpoint: https://servicodados.ibge.gov.br/api/v1/pesquisas/1/indicadores/29171

Documentação API: https://servicodados.ibge.gov.br/api/docs/pesquisas

Autenticação Necessária: Não

Tipo de resposta: JSON

Campos Obrigatórios:

Nome	Tipo	Descrição
pesquisa	number	Identificador da pesquisa
posicao	string	Posição de apenas um indicador ou um ou mais identificadores delimitados pelo caractere \| (pipe). Assume por padrão o valor 0, uma referência abstrata a qualquer indicador.
scope	string	Usado com o parâmetro posição, restringe os indicadores.
localidade	string	Uma ou mais localidades delimitadas por vírgula

Indicadores por pesquisa e períodos pesquisados

Obtém o conjunto de indicadores e os respectivos resultados. Observe que os indicadores são vinculados ao período pesquisado e não à pesquisa. Isso se deve ao fato de que indicadores podem ser desmebrados ou mesmo combinados entre diferentes períodos pesquisados. No entanto, o IBGE se esforça para manter a compatibilidade entre os diversos períodos pesquisados, embora nem sempre isso seja possível.

Pesquisa

URL Base: https://servicodados.ibge.gov.br/api/v1/pesquisas

Endpoint: https://servicodados.ibge.gov.br/api/v1/pesquisas/1/periodos/2022/indicadores/29171

Documentação API: https://servicodados.ibge.gov.br/api/docs/pesquisas

Autenticação Necessária: Não

Tipo de resposta: JSON

Campos Obrigatórios:

Nome	Tipo	Descrição
pesquisa	number	Identificador da pesquisa
posicao	string	Posição de apenas um indicador ou um ou mais identificadores delimitados pelo caractere \| (pipe). Assume por padrão o valor 0, uma referência abstrata a qualquer indicador.
scope	string	Usado com o parâmetro posição, restringe os indicadores.
localidade	string	Uma ou mais localidades delimitadas por vírgula
periodos	string	Período do qual se deseja obter os indicadores.

Períodos por pesquisa

Obtém o conjunto de períodos de uma pesquisa a partir do identificador desta

Pesquisa

Obtém o conjunto de períodos de uma pesquisa a partir do identificador desta

URL Base: https://servicodados.ibge.gov.br/api/v1/pesquisas

Endpoint: https://servicodados.ibge.gov.br/api/v1/pesquisas/1/periodos

Documentação API: https://servicodados.ibge.gov.br/api/docs/pesquisas

Autenticação Necessária: Não

Tipo de resposta: JSON

Campos Obrigatórios:

Nome	Tipo	Descrição
pesquisa	number	Identificador da pesquisa

Pesquisas

Obtém o conjunto de pesquisas. Caso queira restringir o resultado, informe o parâmetro q

Pesquisa

Obtém o conjunto de pesquisas. Caso queira restringir o resultado, informe o parâmetro q

URL Base: https://servicodados.ibge.gov.br/api/v1/pesquisas

Endpoint: https://servicodados.ibge.gov.br/api/v1/pesquisas

Documentação API: https://servicodados.ibge.gov.br/api/docs/pesquisas

Autenticação Necessária: Não

Tipo de resposta: JSON

Campos Obrigatórios:

Nome	Tipo	Descrição
q	string	Critério de busca

Pesquisa por identificador

Obtém o conjunto de pesquisas a partir dos respectivos identificadores

Pesquisa

Obtém o conjunto de pesquisas a partir dos respectivos identificadores

URL Base: https://servicodados.ibge.gov.br/api/v1/pesquisas

Endpoint: https://servicodados.ibge.gov.br/api/v1/pesquisas/1

Documentação API: https://servicodados.ibge.gov.br/api/docs/pesquisas

Autenticação Necessária: Não

Tipo de resposta: JSON

Campos Obrigatórios:

Nome	Tipo	Descrição
pesquisa	number	Identificador da pesquisa

Ranking por pesquisa e indicadores

Funcionalmente igual à consulta /pesquisas/{pesquisa}/periodos/all/indicadores/{indicador}/ranking

Pesquisa

Funcionalmente igual à consulta /pesquisas/{pesquisa}/periodos/all/indicadores/{indicador}/ranking

URL Base: https://servicodados.ibge.gov.br/api/v1/pesquisas

Endpoint: https://servicodados.ibge.gov.br/api/v1/pesquisas/1/indicadores/29171/ranking

Documentação API: https://servicodados.ibge.gov.br/api/docs/pesquisas

Autenticação Necessária: Não

Tipo de resposta: JSON

Campos Obrigatórios:

Nome	Tipo	Descrição
pesquisa	number	Identificador da pesquisa
indicador	string	Um ou mais identificadores de indicador separados pelo caracter \| (pipe)
orderBy	string	Informe como será definido o ordenamento. Pode assumir os valores ASC ou DESC. Por padrão, assume o valor DESC
contexto	string	Contextos do qual será obtido as localidades. Caso mais de um contexto seja informado, use vírgula para separá-los. Por padrão, assume o valor BR. Pode ainda representar uma região do país, como N, NE, SE, S ou CE ou ainda uma Unidade da Federação - Neste caso, usar o código do IBGE
natureza	number	Natureza das localidades obtidas do contexto. Pode ser 3 ou 4, indicando Unidade da Federação e municípios, respectivamente. Por padrão, assume o valor 4
offset	number	Quando especificado, informa o deslocamento relativo ao primeiro registro - Similar à palavra-chave de mesmo nome usado por alguns sistemas de gerenciamento de banco de dados. Usado com os parâmetros lower e upper.
lower	number	Quantidade de registros, a serem retornados, anteriores àquele especificado pelo parâmetro offset ou localidade
upper	number	Quantidade de registros, a serem retornados, posteriores àquele especificado pelo parâmetro offset ou localidade
localidades	string	Equivalente ao parâmetro offset, exceto pelo fato de que o deslocamento é relativo a uma dada localidade

Ranking por pesquisa, períodos pesquisados e indicadores

Obtém o ranking dos resultados de um dado indicador. Válido apenas para indicadores cujas classes sejam N ou $

Pesquisa

Obtém o ranking dos resultados de um dado indicador. Válido apenas para indicadores cujas classes sejam N ou $

URL Base: https://servicodados.ibge.gov.br/api/v1/pesquisas

Endpoint: https://servicodados.ibge.gov.br/api/v1/pesquisas/1/periodos/2022/indicadores/29171/ranking

Documentação API: https://servicodados.ibge.gov.br/api/docs/pesquisas

Autenticação Necessária: Não

Tipo de resposta: JSON

Campos Obrigatórios:

Nome	Tipo	Descrição
pesquisa	number	Identificador da pesquisa
periodos	string	Período do qual se deseja obter os indicadores.
indicador	string	Um ou mais identificadores de indicador separados pelo caracter \| (pipe)
orderBy	string	Informe como será definido o ordenamento. Pode assumir os valores ASC ou DESC. Por padrão, assume o valor DESC
contexto	string	Contextos do qual será obtido as localidades. Caso mais de um contexto seja informado, use vírgula para separá-los. Por padrão, assume o valor BR. Pode ainda representar uma região do país, como N, NE, SE, S ou CE ou ainda uma Unidade da Federação - Neste caso, usar o código do IBGE
natureza	number	Natureza das localidades obtidas do contexto. Pode ser 3 ou 4, indicando Unidade da Federação e municípios, respectivamente. Por padrão, assume o valor 4
offset	number	Quando especificado, informa o deslocamento relativo ao primeiro registro - Similar à palavra-chave de mesmo nome usado por alguns sistemas de gerenciamento de banco de dados. Usado com os parâmetros lower e upper.
lower	number	Quantidade de registros, a serem retornados, anteriores àquele especificado pelo parâmetro offset ou localidade
upper	number	Quantidade de registros, a serem retornados, posteriores àquele especificado pelo parâmetro offset ou localidade
localidades	string	Equivalente ao parâmetro offset, exceto pelo fato de que o deslocamento é relativo a uma dada localidade

Resultados por indicadores e localidades

Obtém os resultados a partir dos identificadores dos indicadores, independente da pesquisa e do período pesquisado. Funcionalmente igual à consulta /pesquisas/-/periodos/all/indicadores/{indicador}/resultados/{localidade}

Pesquisa

URL Base: https://servicodados.ibge.gov.br/api/v1/pesquisas

Endpoint: https://servicodados.ibge.gov.br/api/v1/pesquisas/1/indicadores/29171/resultados/33

Documentação API: https://servicodados.ibge.gov.br/api/docs/pesquisas

Autenticação Necessária: Não

Tipo de resposta: JSON

Campos Obrigatórios:

Nome	Tipo	Descrição
indicador	string	Um ou mais identificadores de indicador separados pelo caracter \| (pipe)
localidades	string	Equivalente ao parâmetro offset, exceto pelo fato de que o deslocamento é relativo a uma dada localidade
groupBy	string	Por padrão, os resultados são agrupados pelo identificador da indicador. Caso deseje que sejam agrupados pelo identificador da localidade, configure o parâmetro groupBy com o valor localidade

Resultados por períodos, indicadores e localidades

Obtém os resultados dos indicadores referentes aos períodos pesquisados, independente da pesquisa

Pesquisa

Obtém os resultados dos indicadores referentes aos períodos pesquisados, independente da pesquisa

URL Base: https://servicodados.ibge.gov.br/api/v1/pesquisas

Endpoint: https://servicodados.ibge.gov.br/api/v1/pesquisas/1/periodos/2022/indicadores/29171/resultados/33

Documentação API: https://servicodados.ibge.gov.br/api/docs/pesquisas

Autenticação Necessária: Não

Tipo de resposta: JSON

Campos Obrigatórios:

Nome	Tipo	Descrição
periodos	string	Período do qual se deseja obter os indicadores.
indicador	string	Um ou mais identificadores de indicador separados pelo caracter \| (pipe)
localidades	string	Equivalente ao parâmetro offset, exceto pelo fato de que o deslocamento é relativo a uma dada localidade
groupBy	string	Por padrão, os resultados são agrupados pelo identificador da indicador. Caso deseje que sejam agrupados pelo identificador da localidade, configure o parâmetro groupBy com o valor localidade

Resultados por pesquisa, indicadores e localidades

Funcionalmente igual à consulta /pesquisas/{pesquisa}/periodos/all/indicadores/{posicao}/resultados/{localidades}

Pesquisa

Funcionalmente igual à consulta /pesquisas/{pesquisa}/periodos/all/indicadores/{posicao}/resultados/{localidades}

URL Base: https://servicodados.ibge.gov.br/api/v1/pesquisas

Endpoint: https://servicodados.ibge.gov.br/api/v1/pesquisas/1/indicadores/29171/resultados/33,35

Documentação API: https://servicodados.ibge.gov.br/api/docs/pesquisas

Autenticação Necessária: Não

Tipo de resposta: JSON

Campos Obrigatórios:

Nome	Tipo	Descrição
pesquisa	number	Identificador da pesquisa
posicao	string	Posição de apenas um indicador ou um ou mais identificadores delimitados pelo caractere \| (pipe). Assume por padrão o valor 0, uma referência abstrata a qualquer indicador.
localidade	string	Uma ou mais localidades delimitadas por vírgula
scope	string	Usado com o parâmetro posição, restringe os indicadores.
groupBy	string	Por padrão, os resultados são agrupados pelo identificador da indicador. Caso deseje que sejam agrupados pelo identificador da localidade, configure o parâmetro groupBy com o valor localidade

Resultados por pesquisa, períodos pesquisados, indicadores e localidades

Obtém os resultados dos indicadores

Pesquisa

Obtém os resultados dos indicadores

URL Base: https://servicodados.ibge.gov.br/api/v1/pesquisas

Endpoint: https://servicodados.ibge.gov.br/api/v1/pesquisas/1/periodos/2022/indicadores/29171/resultados/33

Documentação API: https://servicodados.ibge.gov.br/api/docs/pesquisas

Autenticação Necessária: Não

Tipo de resposta: JSON

Campos Obrigatórios:

Nome	Tipo	Descrição
pesquisa	number	Identificador da pesquisa
posicao	string	Posição de apenas um indicador ou um ou mais identificadores delimitados pelo caractere \| (pipe). Assume por padrão o valor 0, uma referência abstrata a qualquer indicador.
periodos	string	Período do qual se deseja obter os indicadores.
localidades	string	Equivalente ao parâmetro offset, exceto pelo fato de que o deslocamento é relativo a uma dada localidade
scope	string	Usado com o parâmetro posição, restringe os indicadores.
groupBy	string	Por padrão, os resultados são agrupados pelo identificador da indicador. Caso deseje que sejam agrupados pelo identificador da localidade, configure o parâmetro groupBy com o valor localidade

Resultados por pesquisa e localidades

Funcionalmente igual à consulta /pesquisas/{pesquisa}/periodos/all/indicadores/0/resultados/{localidades}

Pesquisa

Funcionalmente igual à consulta /pesquisas/{pesquisa}/periodos/all/indicadores/0/resultados/{localidades}

URL Base: https://servicodados.ibge.gov.br/api/v1/pesquisas

Endpoint: https://servicodados.ibge.gov.br/api/v1/pesquisas/1/resultados/33

Documentação API: https://servicodados.ibge.gov.br/api/docs/pesquisas

Autenticação Necessária: Não

Tipo de resposta: JSON

Campos Obrigatórios:

Nome	Tipo	Descrição
pesquisa	number	Identificador da pesquisa
localidades	string	Equivalente ao parâmetro offset, exceto pelo fato de que o deslocamento é relativo a uma dada localidade
scope	string	Usado com o parâmetro posição, restringe os indicadores.
groupBy	string	Por padrão, os resultados são agrupados pelo identificador da indicador. Caso deseje que sejam agrupados pelo identificador da localidade, configure o parâmetro groupBy com o valor localidade