Table

src.sidrapy.table.get_table(table_code: str, territorial_level: str, ibge_territorial_code: str, variable: Optional[str] = None, classification: Optional[str] = None, categories: Optional[str] = None, classifications: Optional[Dict[str, str]] = None, period: Optional[str] = None, header: Optional[str] = None, format: str = 'pandas', **kwargs)

Realiza a busca da tabela no SIDRA

table_codestr

Código da tabela de onde se deseja extrair os dados

territorial_levelstr

Nível territorial do IBGE.

As opções de níveis territoriais dependem da tabela selecionada.

ibge_territorial_codestr

Unidades territoriais do IBGE. É possível especificar múltiplos elementos utilizando vírgulas.

As opções de unidades territoriais dependem da tabela selecionada.

variablestr, optional (padrão=None)

Variáveis desejadas. Caso não seja espeficiado, é retornado todas as variáveis da tabela, exceto as variáveis de percentual geradas automaticamente pelo Sidra.

As opções de variáveis dependem da tabela selecionada.

classificationsDict[str, str], optional (padrão=None)

Classificações da tabela e suas categorias desejadas. A chave do dicionário é a classificação, e o valor são as categorias. É possível especificar múltiplos categorias utilizando vírgulas.

As opções de classificação e categorias dependem da tabela selecionada.

periodstr, optional (padrão=None)

Períodos (meses, anos etc.) desejados. Caso não seja especificado, traz apenas os períodos mais recentes.

As opções de período dependem da tabela selecionada.

headerstr, optional (padrão=None)

Especifica se o resultado será precedido por um registro de cabeçalho. Caso não seja espefificado, traz o cabeçalho.

Opções:

• ‘y’ - Traz o cabeçalho

• ‘n’ - Não traz o cabeçalho

formatstr, optional (padrão=’pandas’)

Especifica o formato retorano pela API.

Opções:

• ‘pandas’ - Retorna uma pandas Dataframe

• ‘list’ - Retorna uma lista

• list

  Retorna os dados no formato de lista

• pd.DataFrame

  Retorna os dados no formato de dataframe do pandas

>>> import sidrapy
>>> from pprint import pprint
>>> data = sidrapy.get_table(
    table_code="5459",
    territorial_level="1",
    ibge_territorial_code="all",
    classifications={"11278": "33460", "166": "3067,3327"},
    period="202002",
    header='n',
    format='list'
)
>>> pprint(data[:2])  
[
    {
        'D1C': '1',
        'D1N': 'Brasil',
        'D2C': '202002',
        'D2N': '2º semestre 2020',
        'D3C': '33460',
        'D3N': 'menos de 1.200 toneladas',
        'D4C': '3067',
        'D4N': 'Armazéns graneleiros e granelizados',
        'D5C': '152',
        'D5N': 'Número de estabelecimentos',
        'MC': '1020',
        'MN': 'Unidades',
        'NC': '1',
        'NN': 'Brasil',
        'V': '185'
    },
    {
        'D1C': '1',
        'D1N': 'Brasil',
        'D2C': '202002',
        'D2N': '2º semestre 2020',
        'D3C': '33460',
        'D3N': 'menos de 1.200 toneladas',
        'D4C': '3067',
        'D4N': 'Armazéns graneleiros e granelizados',
        'D5C': '153',
        'D5N': 'Capacidade útil',
        'MC': '1017',
        'MN': 'Toneladas',
        'NC': '1',
        'NN': 'Brasil',
        'V': '100870'
    }
]