Instituto de Pesquisa Econômica Aplicada

Searching

You can search for a time series by name with an arbitrary number of arguments:

In [1]: import pandas as pd

In [2]: pd.set_option('display.expand_frame_repr', False, 'display.max_rows', 10)

In [3]: from seriesbr import ipea

In [4]: ipea.search("Taxa", "Selic", "recursos", "livres")
Out[4]: 
           SERCODIGO                                                                                 SERNOME PERNOME UNINOME
0    BM12_CRDCA12     Operações de crédito - recursos direcionados - concessões acumuladas                    Mensal  R$    
1    BM12_CRDCAPF12   Operações de crédito - recursos direcionados - concessões acumuladas - pessoa física    Mensal  R$    
2    BM12_CRDCAPJ12   Operações de crédito - recursos direcionados - concessões acumuladas - pessoa jurídica  Mensal  R$    
3    BM12_CRDIN12     Operações de crédito - recursos direcionados - inadimplência                            Mensal  (%)   
4    BM12_CRDINPF12   Operações de crédito - recursos direcionados - inadimplência - pessoa física            Mensal  (%)   
..              ...                                                                            ...               ...  ...   
469  TxParticip       Taxa de participação                                                                    Anual   (%)   
470  TxParticip_Metr  Taxa de participação - áreas metropolitanas                                             Anual   (%)   
471  TxParticip_NaoM  Taxa de participação - áreas não-metropolitanas                                         Anual   (%)   
472  TxParticip_Rura  Taxa de participação - áreas rurais                                                     Anual   (%)   
473  TxParticip_Urba  Taxa de participação - áreas urbanas não-metropolitanas                                 Anual   (%)   

[474 rows x 4 columns]

And it also accepts keyword arguments to filter by metadata.

For example, if you’re looking for a macroeconomic, monthly time series measured in percent points, you could try:

In [5]: ipea.search(BASNOME="Macroeconômico", PERNOME="Mensal", UNINOME="(p.p.)")
Out[5]: 
             SERCODIGO                                                                  SERNOME PERNOME UNINOME         BASNOME
0   BM12_CRDSD12        Operações de crédito - recursos direcionados - spread                    Mensal  (p.p.)  Macroeconômico
1   BM12_CRDSDPF12      Operações de crédito - recursos direcionados - spread - pessoa física    Mensal  (p.p.)  Macroeconômico
2   BM12_CRDSDPJ12      Operações de crédito - recursos direcionados - spread - pessoa jurídica  Mensal  (p.p.)  Macroeconômico
3   BM12_CRLSD12        Operações de crédito - recursos livres - spread                          Mensal  (p.p.)  Macroeconômico
4   BM12_CRLSDPF12      Operações de crédito - recursos livres - spread - pessoa física          Mensal  (p.p.)  Macroeconômico
..             ...                                                                  ...             ...     ...             ...
10  VALOR12_GLOBAL2412  Bônus global República (24) - spread                                     Mensal  (p.p.)  Macroeconômico
11  VALOR12_GLOBAL2712  Bônus global República (27) - spread                                     Mensal  (p.p.)  Macroeconômico
12  VALOR12_GLOBAL4012  Bônus global República (40) - spread                                     Mensal  (p.p.)  Macroeconômico
13  VALOR12_GLOBAL912   Bônus global República (9) - spread                                      Mensal  (p.p.)  Macroeconômico
14  VALOR12_TJCBOND12   C-Bond - spread                                                          Mensal  (p.p.)  Macroeconômico

[15 rows x 5 columns]

Or, if you want american or german GDP that is still updated:

In [6]: ipea.search("PIB", PAICODIGO=["DEU", "USA"], SERSTATUS="A")
Out[6]: 
           SERCODIGO                                                 SERNOME     PERNOME      UNINOME PAICODIGO SERSTATUS
0   ECONMI4_ALPIBG34  PIB - var. real trimestral anualiz.                     Trimestral  (% a.a.)     DEU       A       
1   ECONMI4_ALPIBG4   PIB - var. real contra igual trimestre do ano anterior  Trimestral  (% a.a.)     DEU       A       
2   ECONMI4_USPIBG34  PIB - var. real trimestral anualiz.                     Trimestral  (% a.a.)     USA       A       
3   ECONMI4_USPIBG4   PIB - var. real contra igual trimestre do ano anterior  Trimestral  (% a.a.)     USA       A       
4   WDI_PIBPPCCAPDEU  PIB - paridade do poder de compra (PPC) - per capita    Anual       US$          DEU       A       
..               ...                                                   ...      ...       ...          ...      ..       
7   WDI_PIBPPCCAPUSA  PIB - paridade do poder de compra (PPC) - per capita    Anual       US$          USA       A       
8   WDI_PIBPPCDEU     PIB - paridade do poder de compra (PPC)                 Anual       US$          DEU       A       
9   WDI_PIBPPCRDEU    PIB - paridade do poder de compra (PPC)                 Anual       US$ de 2011  DEU       A       
10  WDI_PIBPPCRUSA    PIB - paridade do poder de compra (PPC)                 Anual       US$ de 2011  USA       A       
11  WDI_PIBPPCUSA     PIB - paridade do poder de compra (PPC)                 Anual       US$          USA       A       

[12 rows x 6 columns]

Here’s a list of the valid metadatas accepted by the ipea.search function:

Code Description
SERNOME Name
SERCODIGO Code
PERNOME Frequency
TEMCODIGO Theme’s code
UNINOME Unit of measurement
PAICODIGO Country’s code
SERATUALIZACAO Last update
MULNOME Multiplicative factor
SERCOMENTARIO Notes/comments, in portuguese
FNTNOME Source’s name, in portuguese
FNTSIGLA Source’s initials
FNTURL Source’s url
BASNOME Basis’ name
SERSTATUS Active (‘A’), Inactive (‘I’)
SERNUMERICA Numeric (1), Alphanumeric (0)

You can take a look at the available themes and countries with list_themes and list_countries.

In [7]: ipea.list_themes()
Out[7]: 
    TEMCODIGO  TEMCODIGO_PAI                 TEMNOME
0   28        NaN             Agropecuária          
1   23        NaN             Assistência social    
2   10        NaN             Balanço de pagamentos 
3   7         NaN             Câmbio                
4   5         NaN             Comércio exterior     
.. ..          ..                           ...     
38  59         18.0           Senador               
39  17        NaN             Sinopse macroeconômica
40  33        NaN             Transporte            
41  26        NaN             Vendas                
42  60         18.0           Vereador              

[43 rows x 3 columns]

Supposing now we are interested in the theme of employment and macroeconomics, we could search for these themes like this:

In [8]: ipea.search(TEMCODIGO=[12, 17])
Out[8]: 
           SERCODIGO                                                      SERNOME     PERNOME                   UNINOME  TEMCODIGO
0    ADMIS            Total da evolução de admissões                               Mensal      Pessoa                    12       
1    CAGED12_ADMIS    Empregados - admissões                                       Mensal      Pessoa                    12       
2    CAGED12_DESLIG   Empregados - demissões                                       Mensal      Pessoa                    12       
3    CAGED12_SALDO12  Empregados - saldo                                           Mensal      Pessoa                    12       
4    CN_C             Despesas com salários nas atividades da indústria extrativa  Quinquenal  R$, a preços do ano 2000  12       
..    ...                                                                     ...         ...                       ...  ..       
281  PAN4_TD4         Taxa de desemprego                                           Trimestral  (%)                       17       
282  PAN4_TDESOC4     Taxa de desocupação                                          Trimestral  (%)                       17       
283  PAN4_TJOVER4     Taxa de juros nominal - Over / Selic                         Trimestral  (% a.a.)                  17       
284  PAN4_TPR4        Tendência prospectiva para 4 meses - IPCA                    Trimestral  (% a.a.)                  17       
285  PAN4_XTV4        Balança comercial - Exportações (BPM6)                       Trimestral  US$                       17       

[286 rows x 5 columns]
In [9]: ipea.list_countries()
Out[9]: 
   PAICODIGO                      PAINOME
0   ZAF       África do Sul              
1   DEU       Alemanha                   
2   LATI      América Latina             
3   AGO       Angola                     
4   SAU       Arábia Saudita             
..  ...                  ...             
62  THA       Tailândia                  
63  TLS       Timor Leste (Ex-East Timor)
64  URY       Uruguai                    
65  VEN       Venezuela                  
66  ZEUR      Zona do Euro               

[67 rows x 2 columns]
In [10]: ipea.search(PAICODIGO="DEU")
Out[10]: 
            SERCODIGO                                                          SERNOME PERNOME      UNINOME PAICODIGO
0   ECONMI12_ALBCY12   balança comercial - saldo (acum. 12 meses)                       Mensal  US$          DEU     
1   ECONMI12_ALCCY12   balanço - conta corrente - saldo (acum. 12 meses)                Mensal  US$          DEU     
2   ECONMI12_ALPCG12   preços ao consumidor - var. em 12 meses                          Mensal  (% a.a.)     DEU     
3   ECONMI12_ALPIG12   produção industrial - var. em 12 meses                           Mensal  (% a.a.)     DEU     
4   ECONMI12_ALPPG12   preços ao produtor - var. em 12 meses                            Mensal  (% a.a.)     DEU     
..               ...                                     ...                               ...       ...     ...     
26  OCDE_PRODALE       Produtividade por horas trabalhadas - índice (média 2010 = 100)  Anual   -            DEU     
27  WDI_PIBPPCCAPDEU   PIB - paridade do poder de compra (PPC) - per capita             Anual   US$          DEU     
28  WDI_PIBPPCCAPRDEU  PIB - paridade do poder de compra (PPC) - per capita             Anual   US$ de 2011  DEU     
29  WDI_PIBPPCDEU      PIB - paridade do poder de compra (PPC)                          Anual   US$          DEU     
30  WDI_PIBPPCRDEU     PIB - paridade do poder de compra (PPC)                          Anual   US$ de 2011  DEU     

[31 rows x 5 columns]

Getting time series

To get time series values, use seriesbr.ipea.get_series().

In [11]: ipea.get_series({"Taxa de juros - Over / Selic": "BM12_TJOVER12",
   ....:                  "Taxa de juros - CDB": "BM12_TJCDBN12"}, join="inner")
   ....: 
Out[11]: 
            Taxa de juros - Over / Selic  Taxa de juros - CDB
Date                                                         
1974-01-01  1.46                          1.800000           
1974-02-01  1.15                          1.800000           
1974-03-01  1.16                          1.800000           
1974-04-01  1.21                          1.800000           
1974-05-01  1.24                          1.800000           
...          ...                               ...           
2009-06-01  0.76                          0.711593           
2009-07-01  0.79                          0.776809           
2009-08-01  0.69                          0.692135           
2009-09-01  0.69                          0.718573           
2009-10-01  0.69                          0.693355           

[430 rows x 2 columns]

You could also filter by date:

In [12]: ipea.get_series(
   ....:     {"Taxa de juros - Over / Selic": "BM12_TJOVER12"},
   ....:     "BM12_TJCDBN12",
   ....:     join="inner",
   ....:     start="072015",
   ....:     end="072016",
   ....: )
   ....: 
Out[12]: 
            Taxa de juros - Over / Selic
Date                                    
2015-07-01  1.18                        
2015-08-01  1.11                        
2015-09-01  1.11                        
2015-10-01  1.11                        
2015-11-01  1.06                        
...          ...                        
2016-03-01  1.16                        
2016-04-01  1.06                        
2016-05-01  1.11                        
2016-06-01  1.16                        
2016-07-01  1.11                        

[13 rows x 1 columns]

Getting metadata

To get metadata, just call seriesbr.ipea.get_metadata().

In [13]: ipea.get_metadata("BM12_TJOVER12")
Out[13]: 
                                                                                                                                                                                                                                                                                                                                                                                           values
SERCODIGO           BM12_TJOVER12                                                                                                                                                                                                                                                                                                                                                                
SERNOME             Taxa de juros - Over / Selic                                                                                                                                                                                                                                                                                                                                                 
SERCOMENTARIO       Quadro: Taxas de juros efetivas.  Para 1974-1979: fonte Andima.  Dados mais recentes atualizados pela Sinopse da Andima.  Obs.: A taxa Overnight / Selic é a média dos juros que o Governo paga aos bancos que lhe emprestaram dinheiro. Refere-se à média do mês. Serve de referência para outras taxas de juros do país. A taxa Selic é a taxa básica de juros da economia.
SERATUALIZACAO      2019-12-31T15:08:01.613-02:00                                                                                                                                                                                                                                                                                                                                                
BASNOME             Macroeconômico                                                                                                                                                                                                                                                                                                                                                               
...                            ...                                                                                                                                                                                                                                                                                                                                                               
SERMAXDATA          2019-12-01T00:00:00-02:00                                                                                                                                                                                                                                                                                                                                                    
FNTEXTURL           None                                                                                                                                                                                                                                                                                                                                                                         
SERPROGRAMAGERADOR  None                                                                                                                                                                                                                                                                                                                                                                         
SERDECIMAIS         4                                                                                                                                                                                                                                                                                                                                                                            
SERQNT              552                                                                                                                                                                                                                                                                                                                                                                          

[29 rows x 1 columns]