IPCA
indice(data)
Número-índice do IPCA para um mês específico.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
DateLike
|
Qualquer data dentro do mês desejado. |
required |
Returns:
| Type | Description |
|---|---|
float
|
Número-índice do IPCA ou |
Examples:
Source code in pyield/ipca/historico.py
indice_serie(inicio=None, fim=None, *, ultimos=None)
Obtém os valores do número-índice do IPCA por intervalo ou últimos meses.
Realiza chamada à API do portal de dados do IBGE no formato: https://servicodados.ibge.gov.br/api/v3/agregados/1737/periodos/YYYYMM-YYYYMM/variaveis/2266?localidades=N1[all] Para os últimos meses, usa o formato: https://servicodados.ibge.gov.br/api/v3/agregados/1737/periodos/-N/variaveis/2266?localidades=N1[all]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
inicio
|
DateLike | None
|
Data de início do intervalo. |
None
|
fim
|
DateLike | None
|
Data de fim do intervalo. Se |
None
|
ultimos
|
int | None
|
Número de meses mais recentes a recuperar. Se informado,
tem prioridade sobre |
None
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pl.DataFrame com colunas 'periodo' e 'indice'. |
Output Columns
- periodo (Int64): período no formato YYYYMM.
- indice (Float64): número-índice do IPCA.
Raises:
| Type | Description |
|---|---|
ValueError
|
Se não informar |
Examples:
>>> from pyield import ipca
>>> # Obter os números-índice do IPCA para o primeiro trimestre
>>> ipca.indice_serie(inicio="01-01-2025", fim="01-03-2025")
shape: (3, 2)
┌─────────┬─────────┐
│ periodo ┆ indice │
│ --- ┆ --- │
│ i64 ┆ f64 │
╞═════════╪═════════╡
│ 202501 ┆ 7111.86 │
│ 202502 ┆ 7205.03 │
│ 202503 ┆ 7245.38 │
└─────────┴─────────┘
>>> # Obter o número-índice do IPCA do último mês
>>> df = ipca.indice_serie(ultimos=1)
>>> # Obter os números-índice do IPCA dos últimos 3 meses
>>> df = ipca.indice_serie(ultimos=3)
Source code in pyield/ipca/historico.py
taxa(data)
Taxa mensal do IPCA para um mês específico.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
DateLike
|
Qualquer data dentro do mês desejado. |
required |
Returns:
| Type | Description |
|---|---|
float
|
Taxa mensal do IPCA em decimal ou |
Examples:
>>> from pyield import ipca
>>> taxa = ipca.taxa("01-01-2025") # decimal (0.0016 = 0,16%)
>>> f"{taxa:.2%}"
'0.16%'
Source code in pyield/ipca/historico.py
taxa_projetada()
Obtém a projeção atual do IPCA no site da ANBIMA.
A função baixa a planilha XLS de indicadores da ANBIMA e extrai os dados da projeção do IPCA.
Returns:
| Name | Type | Description |
|---|---|---|
ProjecaoIndicador |
ProjecaoIndicador
|
Objeto contendo: - ultima_atualizacao (dt.datetime): Data e hora da última atualização. - periodo_referencia (str): Período de referência no formato "MMM/YY" (ex.: "mar/26"). - valor_projetado (float): Valor projetado do IPCA (decimal). |
Raises:
| Type | Description |
|---|---|
ConnectionError
|
Se houver erro de conexão com o site da ANBIMA. |
ValueError
|
Se os dados esperados não forem encontrados na planilha. |
Notes
Requer conexão com a internet para acessar o site da ANBIMA.
Examples:
>>> from pyield import ipca
>>> # Obter a projeção atual do IPCA na ANBIMA
>>> ipca.taxa_projetada()
ProjecaoIndicador(ultima_atualizacao=..., periodo_referencia=..., valor_projetado=...)
Source code in pyield/ipca/projetado.py
taxa_serie(inicio=None, fim=None, *, ultimos=None)
Obtém as taxas mensais do IPCA por intervalo ou últimos meses.
Realiza chamada à API do portal de dados do IBGE no formato: https://servicodados.ibge.gov.br/api/v3/agregados/1737/periodos/YYYYMM-YYYYMM/variaveis/63?localidades=N1[all] Para os últimos meses, usa o formato: https://servicodados.ibge.gov.br/api/v3/agregados/1737/periodos/-N/variaveis/63?localidades=N1[all]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
inicio
|
DateLike | None
|
Data de início do intervalo. |
None
|
fim
|
DateLike | None
|
Data de fim do intervalo. Se |
None
|
ultimos
|
int | None
|
Número de meses mais recentes a recuperar. Se informado,
tem prioridade sobre |
None
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pl.DataFrame com colunas 'periodo' e 'taxa' (decimal). |
Output Columns
- periodo (Int64): período no formato YYYYMM.
- taxa (Float64): taxa mensal em decimal (ex: 0.0016 = 0,16%).
Raises:
| Type | Description |
|---|---|
ValueError
|
Se não informar |
Examples:
>>> from pyield import ipca
>>> ipca.taxa_serie("01-01-2025", "01-03-2025") # decimal (0.0016 = 0,16%)
shape: (3, 2)
┌─────────┬────────┐
│ periodo ┆ taxa │
│ --- ┆ --- │
│ i64 ┆ f64 │
╞═════════╪════════╡
│ 202501 ┆ 0.0016 │
│ 202502 ┆ 0.0131 │
│ 202503 ┆ 0.0056 │
└─────────┴────────┘
>>> # Obter a taxa do IPCA do último mês
>>> df = ipca.taxa_serie(ultimos=1)
>>> # Obter as taxas do IPCA dos últimos 3 meses
>>> df = ipca.taxa_serie(ultimos=3)