PYield: Toolkit de Renda Fixa Brasileira
Português | English
PYield é uma biblioteca Python voltada para análise de títulos públicos
brasileiros. Ela busca e processa dados da ANBIMA, BCB, IBGE, B3 e Tesouro
Nacional, retornando tipos nativos do Python, polars.Series ou
polars.DataFrame, conforme a operação.
Embora inclua dados e ferramentas de outros mercados, como DI1, DAP e PTAX, esses recursos apoiam o objetivo central da biblioteca: análise, precificação e acompanhamento de títulos públicos brasileiros.
Instalação
Com pip:
pip install pyield
Em um projeto gerenciado pelo uv:
uv add pyield
Próximos passos
- Quickstart: primeiros usos da biblioteca.
- Documentação completa: conceitos e referência por módulo.
- Mapa da API: namespaces e funções públicas.
- Desenvolvimento e publicação: ambiente, verificações, build e PyPI.
- Gerar e publicar a documentação: geração, visualização local e GitHub Pages.
- Notebook no Colab: exploração interativa.
- Pacote no PyPI.
Mapa da API
| Componente | Tipo | Finalidade | Funções públicas |
|---|---|---|---|
yd.du |
módulo | Dias úteis e calendário brasileiro | contar, deslocar, eh_dia_util, gerar, ultimo_dia_util, contar_expr, deslocar_expr, eh_dia_util_expr |
yd.Interpolador |
classe | Interpolação escalar e em pipelines Polars, com métodos linear e flat_forward |
interpolar, interpolar_expr |
yd.interpolar(...) |
função | Interpolação vetorizada flat-forward, curva única ou multi-curva | |
yd.forward(...) |
função | Taxa a termo entre dois vértices | |
yd.forwards(...) |
função | Curva de taxas a termo | |
yd.futuro |
módulo | Contratos futuros da B3 | di1, historico, intradia, datas_disponiveis, vencimento, enriquecer, dv01_expr, vencimento_expr |
yd.di1 |
módulo | Curva DI1 e interpolação | dados, interpolar_taxas, interpolar_taxa, datas_disponiveis |
yd.tpf |
módulo | Títulos públicos federais | taxas, taxas_historicas, vencimentos, estoque, leiloes, benchmarks, dealers, curva_pre, premios_pre, secundario |
yd.rmd(aba) |
função | Relatório Mensal da Dívida do Tesouro Nacional | |
yd.lft |
módulo | LFT | dados, vencimentos, cotacao, pu, taxa, rentabilidade, rentabilidade_expr |
yd.ltn |
módulo | LTN | dados, vencimentos, pu, taxa, duration_expr, dv01, dv01_expr, rentabilidade, rentabilidade_expr, taxas_forward |
yd.ntnb |
módulo | NTN-B | dados, vencimentos, datas_pagamento, fluxos_caixa, cotacao, pu, taxa, taxas_zero, duration, duration_expr, dv01, dv01_expr, implicitas |
yd.ntnb1 |
módulo | NTN-B1 (Educa+ e Renda+) | NomeComercial, datas_pagamento, fluxos_caixa, cotacao, cotacao_curva_zero, taxa_curva_zero, pu, duration, dv01 |
yd.ntnbp |
módulo | NTN-B Principal | cotacao, taxa, pu, dv01 |
yd.ntnc |
módulo | NTN-C | dados, datas_pagamento, fluxos_caixa, cotacao, cotacao_curva_zero, taxa_curva_zero, pu, taxa, duration, duration_expr, dv01, dv01_expr |
yd.ntnf |
módulo | NTN-F | dados, vencimentos, datas_pagamento, fluxos_caixa, pu, taxa, taxas_zero, taxas_zero_forwards, premio_limpo, premio_limpo_expr, rentabilidade, rentabilidade_expr, duration, duration_expr, dv01, dv01_expr |
yd.vna |
módulo | Valores nominais atualizados dos títulos públicos | valor, historico, ultimo, projetado, vigencia, contexto, calcular_vna, calcular_base |
yd.copom |
módulo | Calendário automático do Copom | calendario, proxima_reuniao |
yd.compromissadas(inicio, fim) |
função | Leilões de operações compromissadas do BCB | |
yd.selic |
módulo | Selic e política monetária | over, over_serie, meta, meta_serie |
yd.cpm |
módulo | Opções digitais do COPOM e análises derivadas | contratos, probabilidades |
yd.ipca |
módulo | IPCA histórico e projetado | indice, indice_serie, taxa, taxa_serie, taxa_projetada, calendario |
yd.igpm |
módulo | Taxas e números-índice do IGP-M | taxa, taxa_serie, indice, indice_serie, calendario |
yd.ptax(data) |
função | PTAX para uma data | |
yd.ptax_serie(inicio, fim) |
função | Série histórica da PTAX | |
yd.di_over(data) |
função | Taxa DI Over | |
yd.di_over_serie(inicio, fim) |
função | Série histórica da taxa DI Over | |
yd.b3 |
módulo | Boletins e calendário de pregões da B3 | boletim, eh_pregao, pregao_anterior, proximo_pregao, ultimo_pregao |
yd.hoje() |
função | Data atual no Brasil | |
yd.agora() |
função | Data e hora atual no Brasil |
O mapa completo da API inclui a documentação detalhada e as assinaturas públicas.
Indicadores: taxas e precisão
Selic Over, Selic Meta, DI Over e PTAX retornam decimal.Decimal nas consultas
escalares e colunas Polars Decimal nas séries. Os valores são convertidos
diretamente do texto da fonte: taxas anuais com escala 4, diárias com escala 8
e PTAX com escala 4.
Escalares sem dados retornam Decimal("NaN").
import pyield as yd
taxa_anual = yd.selic.over("28-02-2025")
taxa_diaria = yd.selic.over("28-02-2025", anualizada=False)
serie_diaria = yd.selic.over_serie(ultimos=5, anualizada=False)
di_diaria = yd.di_over("28-02-2025", anualizada=False)
di_serie = yd.di_over_serie("27-02-2025", "28-02-2025")
As taxas Over são anuais em base 252 por padrão; anualizada=False retorna
a taxa ao dia útil publicada pela fonte. Os valores são expressos em unidade
decimal, e as observações têm frequência diária em ambos os casos. Selic Meta
é anual. DI Over passa a usar a API HTTPS do Banco Central em lugar do FTP
da CETIP.
Quem precisar de ponto flutuante pode usar float(taxa_anual) ou converter
a coluna com pl.col("taxa").cast(pl.Float64). Essa conversão pode introduzir
aproximação binária. Veja as notas da 0.63.0 para
os tipos e as orientações de migração.
Notas de versão
Consulte as notas de versão para mudanças, decisões de arquitetura e orientações de migração. As publicações estão disponíveis nas releases do GitHub.
Projeto
Metadata
Release files for pyield 0.64.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pyield-0.64.1.tar.gz | 162.0 kB | Without provenance | Details for pyield-0.64.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pyield-0.64.1-py3-none-any.whl | Python 3 | none | any | Details for pyield-0.64.1-py3-none-any.whl |
Total release size: 374.0 kB
Release files / pyield-0.64.1.tar.gz
| Download URL | pyield-0.64.1.tar.gz |
|---|---|
| Size | 162.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ad35a98d52b8308636bbf44024636a0493295379cd128a7140e43529823b465a
|
|
BLAKE2b-256 checksum How to use checksums |
b214a28dd602d09678faa8bbf50e39fb2f50bd3a3ff53aa5a94fad53717b1026
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / pyield-0.64.1-py3-none-any.whl
| Download URL | pyield-0.64.1-py3-none-any.whl |
|---|---|
| Size | 212.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fa7a406f6f00f3ef3c3b0af62f90d658f603e762ee5983eb24088e8e3414e371
|
|
BLAKE2b-256 checksum How to use checksums |
f936eeba81592cf7d0ea870c4e891635ab52debed7f44d49aa0fc42511c86fd0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for pyield 0.64.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.