Serviço de consulta aos dados do Ipeadata

Introdução

Este documento apresenta a descrição das informações das séries do Ipeadata disponíveis para consulta. Estão disponíveis os metadados e valores das séries, bem como os temas das séries e os territórios de ocorrência dos valores quando de séries Regionais ou Sociais ou o país para as séries Macroeconômicas.

As informações disponíveis para consulta são aquelas que podem ser consultadas através do sistema Ipeadata (http://www.ipeadata.gov.br).

API de consulta

A API de consulta é um serviço web que permite a consulta aos dados da base do Ipeadata através de uma interface exposta em forma de URLs de internet. A URL base do serviço é http://www.ipeadata.gov.br/api/odata4/.

Este serviço implementa uma API RESTful com consultas que seguem a versão 4 do protocolo OData (Open Data Protocol, definido em http://www.odata.org/) e retorna os dados no formato de objetos Javascript (JSON).

O XML de descrição do serviço disponível pode ser consultado através da seguinte URL: http://www.ipeadata.gov.br/api/odata4/$metadata.

O Ipeadata possui bases de dados Macroeconômicos, Regionais e Sociais. Uma série está associada apenas a uma dessas bases de dados e é representada por seus metadados e valores ao longo do tempo e pode estar associada a um território nacional ou a um país. Assim como no site do Ipeadata (http://www.ipeadata.gov.br), cada série também pode estar associada a um tema. As seguintes entidades estão disponíveis para consulta através desta API: Metadados, Valores, Países, Territórios e Temas.

A seguir são descritas brevemente as consultas disponíveis através desta API:

URL (à partir da URL base http://www.ipeadata.gov.br/api/odata4/)	Descrição
Metadados	Registros de metadados de todas as séries disponíveis para consulta.
Metadados('{SERCODIGO}')	Metadados de apenas uma série, de código igual a {SERCODIGO}.
Metadados('{SERCODIGO}')/Valores ou ValoresSerie(SERCODIGO='{SERCODIGO}')	Todos os valores de uma série numérica.
Metadados('{SERCODIGO}')/ValoresStr ou ValoresStrSerie(SERCODIGO='{SERCODIGO}')	Todos os valores de uma série alfanumérica.
Temas	Registros de todos os temas cadastrados.
Temas({TEMCODIGO})	Um único registro de tema, de código igual a {TEMCODIGO}.
Paises	Registros de todos os países cadastrados.
Paises('{PAICODIGO}')	Um único registro de país, de código igual a {PAICODIGO}.
Territorios	Registros de todos os territórios cadastrados.
Territorios(TERCODIGO='{TERCODIGO}',NIVNOME='{NIVNOME}')	Um único registro de país, de código igual a {TERCODIGO} e nível territorial igual a {NIVNOME}. Os níveis territoriais possíveis são: · Brasil · Regiões · Estados · Microrregiões · Mesorregiões · Municípios · Municípios por bacia · Área metropolitana · Estado/RM · AMC 20-00 · AMC 40-00 · AMC 60-00 · AMC 1872-00 · AMC 91-00 · AMC 70-00 · Outros Países

Descrição dos dados disponíveis para consulta

Descrição dos itens do modelo relacional de origem dos dados disponíveis para consulta.

Metadados

Metadados da série. Pode-se identificar unicamente uma série através da coluna SERCODIGO.

Nome da Coluna	Descrição	DataType	Length	Nullable
BASNOME	Nome da base de dados da série.	varchar	14	NULL
FNTNOME	Nome completo da fonte da série, em português.	text	16	NULL
FNTSIGLA	Sigla ou nome abreviado da fonte da série, em português.	varchar	50	NULL
FNTURL	URL para o site da fonte da série.	varchar	150	NULL
MULNOME	Nome do fator multiplicador dos valores da série.	varchar	100	NULL
PERNOME	Nome da periodicidade, em português.	varchar	20	NULL
SERATUALIZACAO	Data da última carga de dados na série.	datetime	8	NULL
SERCODIGO	Código único de identificação da série.	varchar	50	NULL
SERCOMENTARIO	Comentários relativos a série, em português.	text	16	NULL
SERNOME	Nome da série, em português.	varchar	100	NULL
UNINOME	Nome da unidade dos valores da série.	varchar	30	NULL
SERSTATUS	Indica se uma série macroeconômica ainda é atualizada. Valores: ‘A’ (Ativa) para séries atualizadas ou ‘I’ (Inativa) para séries que não são atualizadas. As séries regionais ou sociais não possuem este metadado.	varchar	1	NULL
TEMCODIGO	Código de identificação do tema ao qual a série está associada.	int	4	NOT NULL
PAICODIGO	Código de identificação país ou região (como América Latina, Zona do Euro, etc.) ao qual a série está associada. Deve ser levado em consideração apenas nas séries macroeconômicas (BASNOME = “Macroeconômico”); atualmente todas as séries regionais e sócias se referem ao Brasil, mesmo esta coluna PAICODIGO é nula ou vazia.	varchar	4	NULL
SERNUMERICA	Quando igual a 1, indica que a série possui valores numéricos (tratados como números), quando igual a 0 indica que os valores são alfanuméricos (tratados como cadeias de caracteres). Quando a série for numérica seus valores associados poderão ser encontradas na view vw_Valor, quando for alfanumérica os valores estarão em vw_ValorStr.	bit	1	NULL

País

País ou região (como América Latina, Zona do Euro, etc.) que pode ser associado a uma série. Identificado unicamente pela coluna PAICODIGO. O código possui três caracteres e segue o padrão ISO 3166-1 alfa-3 quando o registro se refere a um país. Caso seja uma região, é utilizado um código composto por quatro caracteres.

A informação de país está associada apenas a séries macroeconômicas; atualmente as séries regionais e sociais estão todas associadas ao Brasil.

Nome da Coluna	Descrição	DataType	Length	Nullable
PAICODIGO	Código do país ou região (como América Latina, Zona do Euro, etc.). O código possui três caracteres e segue o padrão ISO 3166-1 alfa-3 quando o registro se refere a um país. Caso seja uma região, é utilizado um código composto por quatro caracteres.	varchar	4	NOT NULL
PAINOME	Nome do país ou região.	varchar	60	NULL

Tema

Temas das séries do Ipeadata. Pode ser identificado unicamente através da coluna TEMCODIGO.

Nome da Coluna	Descrição	DataType	Length	Nullable
TEMCODIGO	Código único de identificação do tema.	int	4	NOT NULL
TEMCODIGO_PAI	Código do tema pai. Auto referência para montar relação tema-subtema. Cada subtema pode pertencer a apenas 1 tema. Esta coluna não preenchida indica que o registro é um tema. Esta coluna estiver preenchida indica que o registro é um subtema e seu valor identifica o tema ao qual o subtema pertence.	int	4	NULL
TEMNOME	Nome do tema, em português.	varchar	30	NOT NULL

Território

Território que pode ser associado a valores das séries regionais ou sociais. Pode ser identificado unicamente através da composição das colunas NIVNOME e TERCODIGO.

Observação: quando NIVAMC = 0 TERCODIGO não possui repetições.

Nome da Coluna	Descrição	DataType	Length	Nullable
NIVAMC	Indica se o nível é do tipo AMC. Observação: para maiores informações sobre AMCs, consultar o site do Ipeadata e acessar o “Dicionário de conceitos”, que pode ser acessado através do caminho de menus “Ipeadata > Dicas > Dicionário de conceitos”.	bit	1	NULL
NIVNOME	Nome do nível territorial (Brasil, Regiões, Estados, Municípios etc.).	varchar	100	NULL
TERAREA	Área do território (em km²).	float	8	NULL
TERCAPITAL	Indica se o território é capital.	bit	1	NULL
TERCODIGO	Código identificador de território, do IBGE, para territórios dos níveis Brasil, Região, Estado, Mesorregião, Microrregião e Município. Para os demais territórios possui o mesmo valor de UFMUNDV (coluna usada internamente pelo sistema Ipeadata).	varchar	20	NULL
TERNOME	Nome do território.	varchar	100	NULL
TERNOMEPADRAO	Nome padrão do território, todo em maiúsculas e sem acentos ou 'ç'.	varchar	100	NULL

Valores

Numéricos

Valor de cada observação de uma série numérica. Pode-se identificar unicamente uma observação de séries regionais e sociais através da composição das colunas SERCODIGO, VALDATA, NIVNOME e TERCODIGO; pode-se identificar unicamente uma observação de séries macroeconômicas através da composição das colunas SERCODIGO e VALDATA, uma vez que estes registros possuem NIVNOME e TERCODIGO iguais a string vazia. Somente apresenta valores para séries com metadado SERNUMERICA = 1.

Nome da Coluna	Descrição	DataType	Length	Nullable
NIVNOME	Nome do nível territorial (Brasil, Regiões, Estados, Municípios etc.).	varchar	100	NULL
SERCODIGO	Código único de identificação da série.	varchar	50	NULL
TERCODIGO	Código identificador de território, do IBGE, para territórios dos níveis Brasil, Região, Estado, Mesorregião, Microrregião e Município. Para os demais territórios possui o mesmo valor de UFMUNDV. Observação: séries da base “Macroeconômico” não possuem esta coluna preenchida.	varchar	20	NULL
VALDATA	Data do valor.	datetime	8	NOT NULL
VALVALOR	Valor para série na data e no território.	float	8	NULL

Alfanuméricos

Valor de cada observação de uma série não numérica. Pode-se identificar unicamente uma observação de séries regionais e sociais através da composição das colunas SERCODIGO, VALDATA, NIVNOME e TERCODIGO; pode-se identificar unicamente uma observação de séries macroeconômicas através da composição das colunas SERCODIGO e VALDATA, uma vez que estes registros possuem NIVNOME e TERCODIGO iguais a string vazia. Somente apresenta valores para séries com metadado SERNUMERICA = 0.

Nome da Coluna	Descrição	DataType	Length	Nullable
NIVNOME	Nome do nível territorial (Brasil, Regiões, Estados, Municípios etc.).	varchar	100	NULL
SERCODIGO	Código único de identificação da série.	varchar	50	NULL
TERCODIGO	Código identificador de território, do IBGE, para territórios dos níveis Brasil, Região, Estado, Mesorregião, Microrregião e Município. Para os demais territórios possui o mesmo valor de UFMUNDV. Observação: séries da base “Macroeconômico” não possuem esta coluna preenchida.	varchar	20	NULL
VALDATA	Data do valor.	datetime	8	NOT NULL
VALVALOR	Valor para série na data e no território.	varchar	100	NULL