API de pesquisas

Indicadores por pesquisa

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


https://servicodados.ibge.gov.br/api/v1/pesquisas/{pesquisa}/indicadores/{posicao}

Parâmetros

Name Description
pesquisa*
posicao*
Query parameters
Name Description
scope
localidade

Responses

Status: 200 - Array dos indicadores

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 compatilidade entre os diversos períodos pesquisados, embora nem sempre isso seja possível.


https://servicodados.ibge.gov.br/api/v1/pesquisas/{pesquisa}/periodos/{periodos}/indicadores/{posicao}

Parâmetros

Name Description
pesquisa*
periodos*
posicao*
Query parameters
Name Description
scope
localidade

Responses

Status: 200 - Array dos indicadores

Períodos por pesquisa

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


https://servicodados.ibge.gov.br/api/v1/pesquisas/{pesquisa}/periodos

Parâmetros

Name Description
pesquisa*

Responses

Status: 200 - Array de períodos

Pesquisas

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


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

Parâmetros

Query parameters
Name Description
q

Responses

Status: 200 - Array de pesquisas

Pesquisa por identificador

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


https://servicodados.ibge.gov.br/api/v1/pesquisas/{pesquisas}

Parâmetros

Name Description
pesquisas*

Responses

Status: 200 - Um objeto - Caso apenas um identificador seja informado - ou um array de pesquisas

Ranking por pesquisa e indicadores

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


https://servicodados.ibge.gov.br/api/v1/pesquisas/{pesquisa}/indicadores/{indicador}/ranking

Parâmetros

Name Description
pesquisa*
indicador*
Query parameters
Name Description
orderBy
contexto
natureza
offset
lower
upper
localidade

Responses

Status: 200 - Array ordenado do resultados

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 $


https://servicodados.ibge.gov.br/api/v1/pesquisas/{pesquisa}/periodos/{periodos}/indicadores/{indicador}/ranking

Parâmetros

Name Description
pesquisa*
periodos*
indicador*
Query parameters
Name Description
orderBy
contexto
natureza
offset
lower
upper
localidade

Responses

Status: 200 - Array ordenado do resultados

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}


https://servicodados.ibge.gov.br/api/v1/pesquisas/-/indicadores/{indicador}/resultados/{localidade}

Parâmetros

Name Description
indicador*
localidades*
Query parameters
Name Description
groupBy

Responses

Status: 200 - Array dos resultados agrupados pelo indicador ou localidade - Ver parâmetro groupBy

Resultados por períodos, indicadores e localidades

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


https://servicodados.ibge.gov.br/api/v1/pesquisas/-/periodos/{periodos}/indicadores/{indicador}/resultados/{localidade}

Parâmetros

Name Description
periodos*
indicador*
localidades*
Query parameters
Name Description
groupBy

Responses

Status: 200 - Array dos resultados agrupados pelo indicador ou localidade - Ver parâmetro groupBy

Resultados por pesquisa, indicadores e localidades

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


https://servicodados.ibge.gov.br/api/v1/pesquisas/{pesquisa}/indicadores/{posicao}/resultados/{localidades}

Parâmetros

Name Description
pesquisa*
posicao*
localidades*
Query parameters
Name Description
scope
groupBy

Responses

Status: 200 - Array dos resultados agrupados pelo indicador ou localidade - Ver parâmetro groupBy

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

Obtém os resultados dos indicadores


https://servicodados.ibge.gov.br/api/v1/pesquisas/{pesquisa}/periodos/{periodos}/indicadores/{posicao}/resultados/{localidades}

Parâmetros

Name Description
pesquisa*
periodos*
posicao*
localidades*
Query parameters
Name Description
scope
groupBy

Responses

Status: 200 - Array dos resultados agrupados pelo indicador ou localidade - Ver parâmetro groupBy

Resultados por pesquisa e localidades

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


https://servicodados.ibge.gov.br/api/v1/pesquisas/{pesquisa}/resultados/{localidades}

Parâmetros

Name Description
pesquisa*
localidades*
Query parameters
Name Description
scope
groupBy

Responses

Status: 200 - Array dos resultados agrupados pelo indicador ou localidade - Ver parâmetro groupBy

Generated 2018-03-13T14:50:07.194-03:00