NTN-F
dados(data)
Busca as taxas indicativas de NTN-F para a data de referência.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
DateLike
|
Data da consulta. |
required |
Returns:
| Type | Description |
|---|---|
DataFrame
|
pl.DataFrame: DataFrame Polars com os dados de NTN-F. |
Output Columns
- data_referencia (Date): Data de referência dos dados.
- titulo (String): Tipo do título (ex.: "NTN-F").
- codigo_selic (Int64): Código do título no SELIC.
- data_base (Date): Data base de emissão do título.
- data_vencimento (Date): Data de vencimento do título.
- dias_uteis (Int64): Dias úteis entre referência e vencimento.
- prazo_medio (Float64): Prazo médio do título em dias corridos.
- duration (Float64): Macaulay Duration do título (anos).
- dv01 (Float64): Variação no preço para 1bp de taxa.
- pu (Float64): Preço unitário (PU).
- taxa_compra (Float64): Taxa de compra (decimal).
- taxa_venda (Float64): Taxa de venda (decimal).
- taxa_indicativa (Float64): Taxa indicativa (decimal).
- taxa_di (Float64): Taxa de ajuste do DI Futuro interpolada pelo método flat forward.
- taxa_zero (Float64): Taxa zero (zero cupom via bootstrap).
- premio (Float64): prêmio, isto é, o spread sobre o DI.
- premio_limpo (Float64): prêmio limpo sobre a curva DI.
- rentabilidade (Float64): Rentabilidade da NTN-F sobre a curva DI.
Examples:
Source code in pyield/tpf/_titulos/ntnf.py
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 | |
datas_pagamento(data_liquidacao, data_vencimento)
Gera todas as datas de cupom entre liquidação e vencimento.
As datas são exclusivas para a liquidação e inclusivas para o vencimento. Os cupons são pagos em 1º de janeiro e 1º de julho. O título NTN-F é determinado pela data de vencimento.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_liquidacao
|
DateLike
|
Data de liquidação. |
required |
data_vencimento
|
DateLike
|
Data de vencimento. |
required |
Returns:
| Type | Description |
|---|---|
Series
|
pl.Series: Série com as datas de cupom entre a liquidação (exclusiva) e o vencimento (inclusiva). Retorna série vazia se o vencimento for menor ou igual à liquidação. |
Examples:
>>> from pyield import ntnf
>>> ntnf.datas_pagamento("15-05-2024", "01-01-2027")
shape: (6,)
Series: 'datas_pagamento' [date]
[
2024-07-01
2025-01-01
2025-07-01
2026-01-01
2026-07-01
2027-01-01
]
Source code in pyield/tpf/_titulos/ntnf.py
duration(data_liquidacao, data_vencimento, taxa)
Calcula a Macaulay duration de uma NTN-F em anos úteis.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_liquidacao
|
DateLike
|
Data de liquidação para o cálculo. |
required |
data_vencimento
|
DateLike
|
Data de vencimento do título. |
required |
taxa
|
float
|
TIR usada para descontar os fluxos. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Macaulay duration em anos úteis. Retorna NaN se inválido. |
Examples:
>>> from pyield import ntnf
>>> ntnf.duration("02-09-2024", "01-01-2035", 0.121785)
6.32854218039796
Source code in pyield/tpf/_titulos/ntnf.py
duration_expr(data_liquidacao, data_vencimento, taxa)
Cria expressão Polars para a duration da NTN-F.
O cálculo é aplicado linha a linha porque a duration depende dos fluxos de caixa do título.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_liquidacao
|
Expr | str
|
Nome de coluna ou expressão Polars com a data de liquidação. |
required |
data_vencimento
|
Expr | str
|
Nome de coluna ou expressão Polars com a data de vencimento. |
required |
taxa
|
Expr | str
|
Nome de coluna ou expressão Polars com a taxa em formato decimal. |
required |
Returns:
| Type | Description |
|---|---|
Expr
|
pl.Expr: Expressão sem alias com a Macaulay duration em anos úteis. |
Source code in pyield/tpf/_titulos/ntnf.py
dv01(data_liquidacao, data_vencimento, taxa, pu)
Calcula o DV01 (Dollar Value of 01) de uma NTN-F em R$.
Representa a variação do PU informado para um aumento de 1 bp (0,01%) na taxa.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_liquidacao
|
DateLike
|
Data de liquidação. |
required |
data_vencimento
|
DateLike
|
Data de vencimento. |
required |
taxa
|
float
|
Taxa de desconto (TIR) do título. |
required |
pu
|
float
|
PU usado como base para o cálculo. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
DV01, variação de preço para 1 bp. |
Examples:
>>> from pyield import ntnf
>>> pu = ntnf.pu("26-03-2025", "01-01-2035", 0.151375)
>>> ntnf.dv01("26-03-2025", "01-01-2035", 0.151375, pu)
0.3902520000000325
Source code in pyield/tpf/_titulos/ntnf.py
dv01_expr(data_liquidacao, data_vencimento, taxa, pu)
Cria expressão Polars para o DV01 da NTN-F.
O cálculo é aplicado linha a linha e reprifica o PU informado para um aumento de 1 bp na taxa.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_liquidacao
|
Expr | str
|
Nome de coluna ou expressão Polars com a data de liquidação. |
required |
data_vencimento
|
Expr | str
|
Nome de coluna ou expressão Polars com a data de vencimento. |
required |
taxa
|
Expr | str
|
Nome de coluna ou expressão Polars com a taxa em formato decimal. |
required |
pu
|
Expr | str
|
Nome de coluna ou expressão Polars com o PU usado como base. |
required |
Returns:
| Type | Description |
|---|---|
Expr
|
pl.Expr: Expressão sem alias com o DV01. |
Source code in pyield/tpf/_titulos/ntnf.py
fluxos_caixa(data_liquidacao, data_vencimento, ajustar_datas_pagamento=False)
Gera os fluxos de caixa da NTN-F entre liquidação (exclusiva) e vencimento (inclusivo). Os fluxos incluem cupons e o pagamento final no vencimento.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_liquidacao
|
DateLike
|
Data de liquidação (exclusiva). |
required |
data_vencimento
|
DateLike
|
Data de vencimento do título. |
required |
ajustar_datas_pagamento
|
bool
|
Se True, ajusta as datas de pagamento para o próximo dia útil. |
False
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pl.DataFrame: DataFrame com as colunas |
Output Columns
- data_pagamento (Date): Data de pagamento.
- valor_pagamento (Float64): Valor do pagamento.
Examples:
>>> from pyield import ntnf
>>> ntnf.fluxos_caixa("15-05-2024", "01-01-2027")
shape: (6, 2)
┌────────────────┬─────────────────┐
│ data_pagamento ┆ valor_pagamento │
│ --- ┆ --- │
│ date ┆ f64 │
╞════════════════╪═════════════════╡
│ 2024-07-01 ┆ 48.80885 │
│ 2025-01-01 ┆ 48.80885 │
│ 2025-07-01 ┆ 48.80885 │
│ 2026-01-01 ┆ 48.80885 │
│ 2026-07-01 ┆ 48.80885 │
│ 2027-01-01 ┆ 1048.80885 │
└────────────────┴─────────────────┘
Source code in pyield/tpf/_titulos/ntnf.py
premio(data, pontos_base=False)
Calcula o prêmio bruto das NTN-F sobre a curva DI na data de referência.
Definição do prêmio (forma bruta): premio = taxa_indicativa - taxa de ajuste do DI
Quando pontos_base=False a coluna retorna essa diferença em formato decimal
(ex: 0.000439 ≈ 4.39 bps). Quando pontos_base=True o valor é automaticamente
multiplicado por 10_000 e exibido diretamente em basis points.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
DateLike
|
Data da consulta para buscar as taxas. |
required |
pontos_base
|
bool
|
Se True, retorna o prêmio já convertido em basis points. Padrão False. |
False
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pl.DataFrame: DataFrame com as colunas do prêmio. |
Output Columns
- titulo (String): Tipo do título.
- data_vencimento (Date): Data de vencimento.
- premio (Float64): prêmio em decimal ou bps conforme parâmetro, isto é, o spread sobre o DI.
Raises:
| Type | Description |
|---|---|
ValueError
|
Se os dados de DI não possuem 'taxa_ajuste' ou estão vazios. |
Examples:
>>> from pyield import ntnf
>>> ntnf.premio("30-05-2025", pontos_base=True)
shape: (5, 3)
┌────────┬─────────────────┬────────┐
│ titulo ┆ data_vencimento ┆ premio │
│ --- ┆ --- ┆ --- │
│ str ┆ date ┆ f64 │
╞════════╪═════════════════╪════════╡
│ NTN-F ┆ 2027-01-01 ┆ -3.31 │
│ NTN-F ┆ 2029-01-01 ┆ 14.21 │
│ NTN-F ┆ 2031-01-01 ┆ 21.61 │
│ NTN-F ┆ 2033-01-01 ┆ 11.51 │
│ NTN-F ┆ 2035-01-01 ┆ 22.0 │
└────────┴─────────────────┴────────┘
Source code in pyield/tpf/_titulos/ntnf.py
premio_limpo(data_liquidacao, data_vencimento, taxa_ntnf, vencimentos_di, taxas_di)
Calcula o spread líquido (prêmio limpo no jargão de mercado) da NTN-F sobre a curva DI.
A função determina o spread que iguala o valor presente dos fluxos ao preço do título. Interpola as taxas DI nas datas de pagamento e encontra o spread (em bps) que zera a diferença de preços.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_liquidacao
|
DateLike
|
Data de liquidação para o cálculo. |
required |
data_vencimento
|
DateLike
|
Data de vencimento do título. |
required |
taxa_ntnf
|
float
|
TIR do título. |
required |
vencimentos_di
|
DatesLike
|
Vencimentos da curva DI. |
required |
taxas_di
|
ArrayLike
|
Série de taxas DI. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Spread líquido em formato decimal (ex.: 0.0012 = 12 bps). Retorna NaN em caso de erro. |
Examples:
Obs: apenas algumas taxas DI serão usadas no exemplo.
>>> exp_dates = ["2025-01-01", "2030-01-01", "2035-01-01"]
>>> taxas_di = [0.10823, 0.11594, 0.11531]
>>> spread = premio_limpo(
... data_liquidacao="23-08-2024",
... data_vencimento="01-01-2035",
... taxa_ntnf=0.116586,
... vencimentos_di=exp_dates,
... taxas_di=taxas_di,
... )
>>> round(spread * 10_000, 2) # Converte para bps para exibição
12.13
Source code in pyield/tpf/_titulos/ntnf.py
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 | |
premio_limpo_expr(data_liquidacao, data_vencimento, taxa_ntnf, vencimentos_di, taxas_di)
Cria expressão Polars para o prêmio limpo da NTN-F sobre a curva DI.
O cálculo é aplicado linha a linha porque o prêmio limpo depende dos fluxos de caixa do título, da interpolação da curva DI e da resolução de raiz.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_liquidacao
|
DateLike
|
Data de liquidação para o cálculo. |
required |
data_vencimento
|
Expr | str
|
Nome de coluna ou expressão Polars com a data de vencimento da NTN-F. |
required |
taxa_ntnf
|
Expr | str
|
Nome de coluna ou expressão Polars com a TIR da NTN-F. |
required |
vencimentos_di
|
DatesLike
|
Datas de vencimento da curva DI. |
required |
taxas_di
|
ArrayLike
|
Taxas DI correspondentes aos vencimentos. |
required |
Returns:
| Type | Description |
|---|---|
Expr
|
pl.Expr: Expressão sem alias com o prêmio limpo da NTN-F sobre a curva |
Expr
|
DI. |
Source code in pyield/tpf/_titulos/ntnf.py
pu(data_liquidacao, data_vencimento, taxa)
Calcula o preço (PU) da NTN-F pelas regras da ANBIMA, equivalente ao valor presente dos fluxos descontados pela TIR informada.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_liquidacao
|
DateLike
|
Data de liquidação para cálculo do preço. |
required |
data_vencimento
|
DateLike
|
Data de vencimento do título. |
required |
taxa
|
float
|
Taxa de desconto (TIR) usada para calcular o valor presente. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Preço da NTN-F conforme ANBIMA. |
References
- https://www.anbima.com.br/data/files/A0/02/CC/70/8FEFC8104606BDC8B82BA2A8/Metodologias%20ANBIMA%20de%20Precificacao%20Titulos%20Publicos.pdf
- O cupom semestral é 48,81, que representa 10% a.a. com capitalização semestral e arredondamento para 5 casas, conforme ANBIMA.
Examples:
Source code in pyield/tpf/_titulos/ntnf.py
rentabilidade(data_liquidacao, data_vencimento, taxa_ntnf, vencimentos_di, taxas_di)
Calcula a rentabilidade de uma NTN-F sobre a curva DI.
A função compara o fator de desconto implícito da NTN-F com o da curva DI, determinando quanto a NTN-F rende em relação ao DI. Interpola as taxas DI nas datas de pagamento e calcula o valor presente dos fluxos da NTN-F usando essas taxas. Encontra a TIR da curva DI que iguala o preço da NTN-F.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_liquidacao
|
DateLike
|
Data de liquidação para o cálculo. |
required |
data_vencimento
|
DateLike
|
Data de vencimento da NTN-F. |
required |
taxa_ntnf
|
float
|
TIR da NTN-F. |
required |
vencimentos_di
|
DatesLike
|
Datas de vencimento da curva DI. |
required |
taxas_di
|
ArrayLike
|
Taxas DI correspondentes aos vencimentos. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Rentabilidade da NTN-F sobre a curva DI. Retorna NaN em erro. |
Examples:
>>> # Obs: apenas algumas taxas DI serão usadas no exemplo.
>>> exp_dates = ["2025-01-01", "2030-01-01", "2035-01-01"]
>>> taxas_di = [0.10823, 0.11594, 0.11531]
>>> rentabilidade(
... data_liquidacao="23-08-2024",
... data_vencimento="01-01-2035",
... taxa_ntnf=0.116586,
... vencimentos_di=exp_dates,
... taxas_di=taxas_di,
... )
1.0099602679927115
Notes
A função ajusta as datas de pagamento para dias úteis e calcula o valor presente dos fluxos da NTN-F usando as taxas DI.
Source code in pyield/tpf/_titulos/ntnf.py
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 | |
rentabilidade_expr(data_liquidacao, data_vencimento, taxa_ntnf, vencimentos_di, taxas_di)
Cria expressão Polars para a rentabilidade da NTN-F sobre a curva DI.
O cálculo é aplicado linha a linha porque a rentabilidade depende dos fluxos de caixa do título, da interpolação da curva DI e da resolução de raiz.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_liquidacao
|
DateLike
|
Data de liquidação para o cálculo. |
required |
data_vencimento
|
Expr | str
|
Nome de coluna ou expressão Polars com a data de vencimento da NTN-F. |
required |
taxa_ntnf
|
Expr | str
|
Nome de coluna ou expressão Polars com a TIR da NTN-F. |
required |
vencimentos_di
|
DatesLike
|
Datas de vencimento da curva DI. |
required |
taxas_di
|
ArrayLike
|
Taxas DI correspondentes aos vencimentos. |
required |
Returns:
| Type | Description |
|---|---|
Expr
|
pl.Expr: Expressão sem alias com a rentabilidade da NTN-F sobre a curva |
Expr
|
DI. |
Source code in pyield/tpf/_titulos/ntnf.py
taxa(data_liquidacao, data_vencimento, pu)
Calcula a TIR implícita de uma NTN-F a partir de um PU informado.
A função inverte numericamente o cálculo de pu(), encontrando a taxa
que zera a diferença entre o preço calculado e o preço desejado.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_liquidacao
|
DateLike
|
Data de liquidação. |
required |
data_vencimento
|
DateLike
|
Data de vencimento. |
required |
pu
|
float
|
Preço unitário (PU) do título. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
TIR implícita em formato decimal. Retorna NaN em caso de erro. |
Examples:
>>> from pyield import ntnf
>>> pu = ntnf.pu("05-07-2024", "01-01-2035", 0.11921)
>>> ntnf.taxa("13-03-2026", "01-01-2035", 820.995125)
0.142743
Source code in pyield/tpf/_titulos/ntnf.py
taxas_zero(data_liquidacao, vencimentos_ltn, taxas_ltn, vencimentos_ntnf, taxas_ntnf, incluir_cupons=False)
Calcula as taxas spot (zero cupom) para NTN-F usando bootstrap.
O bootstrap determina as taxas spot a partir dos yields dos títulos. O método resolve iterativamente as taxas que descontam os fluxos ao preço. Usa as LTNs (zero cupom) até o último vencimento LTN disponível. Após isso, calcula as taxas spot a partir das NTN-F.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_liquidacao
|
DateLike
|
Data de liquidação para o cálculo. |
required |
vencimentos_ltn
|
DatesLike
|
Datas de vencimento das LTNs usadas como vértices prefixados zero cupom. |
required |
taxas_ltn
|
ArrayLike
|
Taxas das LTNs. Como a LTN é zero cupom, essas taxas são usadas diretamente como taxas zero no bootstrap. |
required |
vencimentos_ntnf
|
DatesLike
|
Datas de vencimento das NTN-F usadas no bootstrap. |
required |
taxas_ntnf
|
ArrayLike
|
TIRs das NTN-F correspondentes aos vencimentos informados. |
required |
incluir_cupons
|
bool
|
Se True, inclui as datas de cupom (julho). Padrão False. |
False
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pl.DataFrame: DataFrame com colunas |
Output Columns
- data_vencimento (Date): Data de vencimento.
- dias_uteis (Int64): Dias úteis entre liquidação e vencimento.
- taxa_zero (Float64): Taxa zero (zero cupom).
Examples:
>>> from pyield import ntnf, ltn
>>> df_ltn = ltn.dados("03-09-2024")
>>> df_ntnf = ntnf.dados("03-09-2024")
>>> ntnf.taxas_zero(
... data_liquidacao="03-09-2024",
... vencimentos_ltn=df_ltn["data_vencimento"],
... taxas_ltn=df_ltn["taxa_indicativa"],
... vencimentos_ntnf=df_ntnf["data_vencimento"],
... taxas_ntnf=df_ntnf["taxa_indicativa"],
... )
shape: (6, 3)
┌─────────────────┬────────────┬───────────┐
│ data_vencimento ┆ dias_uteis ┆ taxa_zero │
│ --- ┆ --- ┆ --- │
│ date ┆ i64 ┆ f64 │
╞═════════════════╪════════════╪═══════════╡
│ 2025-01-01 ┆ 83 ┆ 0.108837 │
│ 2027-01-01 ┆ 584 ┆ 0.119981 │
│ 2029-01-01 ┆ 1083 ┆ 0.122113 │
│ 2031-01-01 ┆ 1584 ┆ 0.122231 │
│ 2033-01-01 ┆ 2088 ┆ 0.121355 │
│ 2035-01-01 ┆ 2587 ┆ 0.121398 │
└─────────────────┴────────────┴───────────┘
Source code in pyield/tpf/_titulos/ntnf.py
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 | |
vencimentos(data)
Busca os vencimentos de NTN-F disponíveis para a data de referência.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
DateLike
|
Data da consulta. |
required |
Returns:
| Type | Description |
|---|---|
Series
|
pl.Series: Série de datas de vencimento de NTN-F. |
Examples:
>>> from pyield import ntnf
>>> ntnf.vencimentos("23-08-2024")
shape: (6,)
Series: 'data_vencimento' [date]
[
2025-01-01
2027-01-01
2029-01-01
2031-01-01
2033-01-01
2035-01-01
]