Pular para conteúdo

NTN-B

cotacao(data_liquidacao, data_vencimento, taxa)

Calcula a cotação da NTN-B pela metodologia da STN para leilões primários.

Parameters:

Name Type Description Default
data_liquidacao DateLike

Data de liquidação da operação.

 required
data_vencimento DateLike

Data de vencimento da NTN-B.

 required
taxa float | Decimal

Taxa de desconto (TIR) em formato decimal.

 required

Returns:

Name Type Description
Decimal Decimal

Fator de cotação em base 1, truncado em 6 casas. Retorna Decimal('NaN') em erro.
Notes

A STN apresenta a cotação na escala percentual (base 100). Esta função retorna o fator equivalente em base 1, usado diretamente no cálculo do PU. O truncamento de 4 casas na escala STN equivale ao truncamento de 6 casas nesta representação.

O cupom semestral definido pela STN como 2,956301% é armazenado como 0,02956301 em base 1.

References
  • Secretaria do Tesouro Nacional. Metodologia de Cálculo dos Títulos Públicos Federais Ofertados nos Leilões Primários. https://crdcj.github.io/PYield/referencias/metodologia-calculo-tpf-stn/

Examples:

>>> from pyield import ntnb
>>> ntnb.cotacao("31-05-2024", "15-05-2035", 0.061490)
Decimal('0.993651')
>>> ntnb.cotacao("31-05-2024", "15-08-2060", 0.061878)
Decimal('0.995341')
>>> ntnb.cotacao("15-08-2024", "15-08-2032", 0.05929)
Decimal('1.006409')
>>> ntnb.cotacao("15-05-2024", "15-05-2025", 0.10)
Decimal('0.964454')
>>> ntnb.cotacao("21-05-2008", "15-08-2010", 0.082900009)
Decimal('0.970813')
Source code in pyield/tpf/titulos/ntnb.py 
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
def cotacao(
    data_liquidacao: DateLike,
    data_vencimento: DateLike,
    taxa: float | Decimal,
) -> Decimal:
    """
    Calcula a cotação da NTN-B pela metodologia da STN para leilões primários.

    Args:
        data_liquidacao (DateLike): Data de liquidação da operação.
        data_vencimento (DateLike): Data de vencimento da NTN-B.
        taxa: Taxa de desconto (TIR) em formato decimal.

    Returns:
        Decimal: Fator de cotação em base 1, truncado em 6 casas. Retorna
            Decimal('NaN') em erro.

    Notes:
        A STN apresenta a cotação na escala percentual (base 100). Esta
        função retorna o fator equivalente em base 1, usado diretamente no
        cálculo do PU. O truncamento de 4 casas na escala STN equivale ao
        truncamento de 6 casas nesta representação.

        O cupom semestral definido pela STN como 2,956301% é armazenado
        como 0,02956301 em base 1.

    References:
        - Secretaria do Tesouro Nacional. Metodologia de Cálculo dos Títulos
          Públicos Federais Ofertados nos Leilões Primários.
          https://crdcj.github.io/PYield/referencias/metodologia-calculo-tpf-stn/

    Examples:
        >>> from pyield import ntnb
        >>> ntnb.cotacao("31-05-2024", "15-05-2035", 0.061490)
        Decimal('0.993651')
        >>> ntnb.cotacao("31-05-2024", "15-08-2060", 0.061878)
        Decimal('0.995341')
        >>> ntnb.cotacao("15-08-2024", "15-08-2032", 0.05929)
        Decimal('1.006409')
        >>> ntnb.cotacao("15-05-2024", "15-05-2025", 0.10)
        Decimal('0.964454')
        >>> ntnb.cotacao("21-05-2008", "15-08-2010", 0.082900009)
        Decimal('0.970813')
    """
    if any_is_empty(data_liquidacao, data_vencimento, taxa):
        return Decimal("NaN")
    taxa = utils.normalizar_taxa_precificacao(taxa)

    df_fluxos = fluxos_caixa(data_liquidacao, data_vencimento)
    if df_fluxos.is_empty():
        return Decimal("NaN")

    valores_fluxo = df_fluxos["valor_pagamento"]
    dias_uteis = du.contar(data_liquidacao, df_fluxos["data_pagamento"])
    anos_uteis = utils.truncar(dias_uteis / 252, 14)
    fatores_desconto = (1 + taxa) ** anos_uteis
    # Calcula o valor presente de cada fluxo com arredondamento STN
    vp = (valores_fluxo / fatores_desconto).round(12)
    # Retorna a cotação (soma dos valores presentes) com truncamento STN
    return truncar_decimal(vp.sum(), 6)

dados(data)

Busca as taxas indicativas de NTN-B 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-B.
Output Columns
  • data_referencia (Date): Data de referência dos dados.
  • titulo (String): Tipo do título (ex.: "NTN-B").
  • 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.
  • duration (Float64): Macaulay Duration do título (anos).
  • prazo_medio (Float64): Prazo médio 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 real (via bootstrap das taxas indicativas).
  • taxa_forward (Float64): Taxa forward real (a partir das taxas zero).
  • inflacao_implicita (Float64): Inflação implícita (breakeven) calculada a partir de taxas nominais do DI Futuro e taxas zero das NTN-B.

Examples:

>>> from pyield import ntnb
>>> df_ntnb = ntnb.dados("23-08-2024")
Source code in pyield/tpf/titulos/ntnb.py 
 28
 29
 30
 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
def dados(data: DateLike) -> pl.DataFrame:
    """
    Busca as taxas indicativas de NTN-B para a data de referência.

    Args:
        data (DateLike): Data da consulta.

    Returns:
        pl.DataFrame: DataFrame Polars com os dados de NTN-B.

    Output Columns:
        - data_referencia (Date): Data de referência dos dados.
        - titulo (String): Tipo do título (ex.: "NTN-B").
        - 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.
        - duration (Float64): Macaulay Duration do título (anos).
        - prazo_medio (Float64): Prazo médio 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 real (via bootstrap das taxas indicativas).
        - taxa_forward (Float64): Taxa forward real (a partir das taxas zero).
        - inflacao_implicita (Float64): Inflação implícita (breakeven) calculada
            a partir de taxas nominais do DI Futuro e taxas zero das NTN-B.

    Examples:
        >>> from pyield import ntnb
        >>> df_ntnb = ntnb.dados("23-08-2024")
    """
    from pyield.futuro import di1  # noqa: PLC0415

    df = utils.obter_tpf(data, "NTN-B")
    if df.is_empty():
        return df

    # Adiciona duration, prazo_medio e dv01
    df = df.with_columns(
        dias_uteis=du.contar_expr("data_referencia", "data_vencimento"),
        duration=duration_expr("data_referencia", "data_vencimento", "taxa_indicativa"),
    ).with_columns(
        prazo_medio=pl.col("duration"),
        dv01=dv01_expr("data_referencia", "data_vencimento", "taxa_indicativa", "pu"),
    )

    # Busca curva DI bruta e calcula taxa_zero, taxa_di e inflação implícita
    df_di = di1.dados(data)
    df_bei = implicitas(
        data_liquidacao=data,
        vencimentos_tir=df["data_vencimento"],
        taxas_tir=df["taxa_indicativa"],
        vencimentos_nominais=df_di["data_vencimento"],
        taxas_nominais=df_di["taxa_ajuste"],
    ).select(
        pl.col("data_vencimento"),
        pl.col("taxa_zero_real").alias("taxa_zero"),
        pl.col("taxa_nominal").alias("taxa_di"),
        pl.col("inflacao_implicita"),
    )

    df = df.join(df_bei, on="data_vencimento", how="left")

    # Calcula taxas forward a partir das taxas zero
    df = df.with_columns(taxa_forward=fwd.forwards_expr("dias_uteis", "taxa_zero"))

    return df.select(
        "data_referencia",
        "titulo",
        "codigo_selic",
        "data_base",
        "data_vencimento",
        "dias_uteis",
        "duration",
        "prazo_medio",
        "dv01",
        "pu",
        "taxa_compra",
        "taxa_venda",
        "taxa_indicativa",
        "taxa_di",
        "taxa_zero",
        "taxa_forward",
        "inflacao_implicita",
    )

datas_pagamento(data_liquidacao, data_vencimento)

Gera todas as datas de pagamento entre liquidação e vencimento.

Os pagamentos são semestrais e seguem a série do título, com datas em 15/02, 15/05, 15/08 ou 15/11. No vencimento, o fluxo inclui o último cupom e a amortização do principal. As datas são contratuais e não são ajustadas para dias úteis.

Parameters:

Name Type Description Default
data_liquidacao DateLike

Data de liquidação (exclusiva).

 required
data_vencimento DateLike

Data de vencimento.

 required

Returns:

Type Description
Series

pl.Series: Série de datas de pagamento entre a liquidação (exclusiva) e o vencimento (inclusivo). Retorna série vazia se o vencimento for menor ou igual à liquidação.
Notes

Para obter as datas efetivas de processamento, use yd.du.deslocar(..., 0).

Examples:

>>> from pyield import ntnb
>>> ntnb.datas_pagamento("10-05-2024", "15-05-2025")
shape: (3,)
Series: 'datas_pagamento' [date]
[
    2024-05-15
    2024-11-15
    2025-05-15
]

A data de liquidação coincidente com um pagamento é exclusiva:

>>> ntnb.datas_pagamento("15-05-2024", "15-05-2025")
shape: (2,)
Series: 'datas_pagamento' [date]
[
    2024-11-15
    2025-05-15
]
Source code in pyield/tpf/titulos/ntnb.py 
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
def datas_pagamento(
    data_liquidacao: DateLike,
    data_vencimento: DateLike,
) -> pl.Series:
    """
    Gera todas as datas de pagamento entre liquidação e vencimento.

    Os pagamentos são semestrais e seguem a série do título, com datas em
    15/02, 15/05, 15/08 ou 15/11. No vencimento, o fluxo inclui o último cupom
    e a amortização do principal. As datas são contratuais e não são ajustadas
    para dias úteis.

    Args:
        data_liquidacao (DateLike): Data de liquidação (exclusiva).
        data_vencimento (DateLike): Data de vencimento.

    Returns:
        pl.Series: Série de datas de pagamento entre a liquidação (exclusiva)
            e o vencimento (inclusivo). Retorna série vazia se o vencimento for
            menor ou igual à liquidação.

    Notes:
        Para obter as datas efetivas de processamento, use
        ``yd.du.deslocar(..., 0)``.

    Examples:
        >>> from pyield import ntnb
        >>> ntnb.datas_pagamento("10-05-2024", "15-05-2025")
        shape: (3,)
        Series: 'datas_pagamento' [date]
        [
            2024-05-15
            2024-11-15
            2025-05-15
        ]

        A data de liquidação coincidente com um pagamento é exclusiva:

        >>> ntnb.datas_pagamento("15-05-2024", "15-05-2025")
        shape: (2,)
        Series: 'datas_pagamento' [date]
        [
            2024-11-15
            2025-05-15
        ]
    """
    return utils.gerar_datas_pagamento(data_liquidacao, data_vencimento)

duration(data_liquidacao, data_vencimento, taxa)

Calcula a Macaulay duration da NTN-B em anos úteis.

Fórmula

Sum( t * CFₜ / (1 + y)ᵗ )

 MacD = ---------------------------------
                 Current Bond Price
Onde

t = tempo (anos) até o pagamento CFₜ = fluxo no tempo t y = TIR (periódica) Price = Soma( CFₜ / (1 + y)ᵗ )

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 usada no cálculo.

 required

Returns:

Name Type Description
float float

Macaulay duration em anos úteis.

Examples:

>>> from pyield import ntnb
>>> ntnb.duration("23-08-2024", "15-08-2060", 0.061005)
15.08305431313045
Source code in pyield/tpf/titulos/ntnb.py 
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
def duration(
    data_liquidacao: DateLike,
    data_vencimento: DateLike,
    taxa: float,
) -> float:
    """
    Calcula a Macaulay duration da NTN-B em anos úteis.

    Fórmula:
                   Sum( t * CFₜ / (1 + y)ᵗ )
         MacD = ---------------------------------
                         Current Bond Price

    Onde:
        t    = tempo (anos) até o pagamento
        CFₜ = fluxo no tempo t
        y    = TIR (periódica)
        Price = Soma( CFₜ / (1 + y)ᵗ )

    Args:
        data_liquidacao (DateLike): Data de liquidação.
        data_vencimento (DateLike): Data de vencimento.
        taxa (float): Taxa de desconto usada no cálculo.

    Returns:
        float: Macaulay duration em anos úteis.

    Examples:
        >>> from pyield import ntnb
        >>> ntnb.duration("23-08-2024", "15-08-2060", 0.061005)
        15.08305431313045
    """
    if any_is_empty(data_liquidacao, data_vencimento, taxa):
        return float("nan")

    df_fluxos = fluxos_caixa(data_liquidacao, data_vencimento)
    if df_fluxos.is_empty():
        return float("nan")

    anos_uteis = du.contar(data_liquidacao, df_fluxos["data_pagamento"]) / 252
    vp = df_fluxos["valor_pagamento"] / (1 + taxa) ** anos_uteis
    duration = float((vp * anos_uteis).sum()) / float(vp.sum())
    # Truncar para 14 casas decimais para repetibilidade dos resultados
    return utils.truncar(duration, 14)

duration_expr(data_liquidacao, data_vencimento, taxa)

Cria expressão Polars para a duration da NTN-B.

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/ntnb.py 
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
794
795
796
def duration_expr(
    data_liquidacao: pl.Expr | str,
    data_vencimento: pl.Expr | str,
    taxa: pl.Expr | str,
) -> pl.Expr:
    """Cria expressão Polars para a duration da NTN-B.

    O cálculo é aplicado linha a linha porque a duration depende dos fluxos de
    caixa do título.

    Args:
        data_liquidacao: Nome de coluna ou expressão Polars com a data de
            liquidação.
        data_vencimento: Nome de coluna ou expressão Polars com a data de
            vencimento.
        taxa: Nome de coluna ou expressão Polars com a taxa em formato decimal.

    Returns:
        pl.Expr: Expressão sem alias com a Macaulay duration em anos úteis.
    """
    return pl.struct(
        utils.coluna_ou_expr(data_liquidacao, "data_liquidacao"),
        utils.coluna_ou_expr(data_vencimento, "data_vencimento"),
        utils.coluna_ou_expr(taxa, "taxa"),
    ).map_elements(
        lambda s: duration(
            s["data_liquidacao"],
            s["data_vencimento"],
            s["taxa"],
        ),
        return_dtype=pl.Float64,
    )

dv01(data_liquidacao, data_vencimento, taxa, pu)

Calcula o DV01 (Dollar Value of 01) da NTN-B 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) da NTN-B.

 required
pu float | Decimal

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 ntnb
>>> cot = ntnb.cotacao("26-03-2025", "15-08-2060", 0.074358)
>>> pu = ntnb.pu(4470.979474, cot)
>>> ntnb.dv01("26-03-2025", "15-08-2060", 0.074358, pu)
4.640876692897651
Source code in pyield/tpf/titulos/ntnb.py 
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
def dv01(
    data_liquidacao: DateLike,
    data_vencimento: DateLike,
    taxa: float,
    pu: float | Decimal,
) -> float:
    """
    Calcula o DV01 (Dollar Value of 01) da NTN-B em R$.

    Representa a variação do PU informado para um aumento de 1 bp (0,01%) na
    taxa.

    Args:
        data_liquidacao (DateLike): Data de liquidação.
        data_vencimento (DateLike): Data de vencimento.
        taxa (float): Taxa de desconto (TIR) da NTN-B.
        pu: PU usado como base para o cálculo.

    Returns:
        float: DV01, variação de preço para 1 bp.

    Examples:
        >>> from pyield import ntnb
        >>> cot = ntnb.cotacao("26-03-2025", "15-08-2060", 0.074358)
        >>> pu = ntnb.pu(4470.979474, cot)
        >>> ntnb.dv01("26-03-2025", "15-08-2060", 0.074358, pu)
        4.640876692897651
    """
    if any_is_empty(data_liquidacao, data_vencimento, taxa, pu):
        return float("nan")

    taxa = utils.normalizar_taxa_precificacao(taxa)
    taxa_mais_1bp = round(taxa + 0.0001, 8)
    cotacao_1 = float(cotacao(data_liquidacao, data_vencimento, taxa))
    cotacao_2 = float(cotacao(data_liquidacao, data_vencimento, taxa_mais_1bp))
    return float(pu) * (1 - cotacao_2 / cotacao_1)

dv01_expr(data_liquidacao, data_vencimento, taxa, pu)

Cria expressão Polars para o DV01 da NTN-B.

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/ntnb.py 
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
def dv01_expr(
    data_liquidacao: pl.Expr | str,
    data_vencimento: pl.Expr | str,
    taxa: pl.Expr | str,
    pu: pl.Expr | str,
) -> pl.Expr:
    """Cria expressão Polars para o DV01 da NTN-B.

    O cálculo é aplicado linha a linha e reprifica o PU informado para um
    aumento de 1 bp na taxa.

    Args:
        data_liquidacao: Nome de coluna ou expressão Polars com a data de
            liquidação.
        data_vencimento: Nome de coluna ou expressão Polars com a data de
            vencimento.
        taxa: Nome de coluna ou expressão Polars com a taxa em formato decimal.
        pu: Nome de coluna ou expressão Polars com o PU usado como base.

    Returns:
        pl.Expr: Expressão sem alias com o DV01.
    """
    return pl.struct(
        utils.coluna_ou_expr(data_liquidacao, "data_liquidacao"),
        utils.coluna_ou_expr(data_vencimento, "data_vencimento"),
        utils.coluna_ou_expr(taxa, "taxa"),
        utils.coluna_ou_expr(pu, "pu"),
    ).map_elements(
        lambda s: dv01(
            s["data_liquidacao"],
            s["data_vencimento"],
            s["taxa"],
            s["pu"],
        ),
        return_dtype=pl.Float64,
    )

fluxos_caixa(data_liquidacao, data_vencimento)

Gera os fluxos de caixa da NTN-B entre liquidação e vencimento.

Parameters:

Name Type Description Default
data_liquidacao DateLike

Data de liquidação (exclusiva).

 required
data_vencimento DateLike

Data de vencimento.

 required

Returns:

Type Description
DataFrame

pl.DataFrame: DataFrame com as colunas de fluxo.
Output Columns
  • data_pagamento (Date): Data contratual do pagamento, sem ajuste para dia útil.
  • valor_pagamento (Float64): Valor do pagamento em base 1.
Notes

Para obter as datas efetivas de processamento, use yd.du.deslocar(..., 0).

Examples:

>>> from pyield import ntnb
>>> with pl.Config(float_precision=8):
...     ntnb.fluxos_caixa("10-05-2024", "15-05-2025")
shape: (3, 2)
┌────────────────┬─────────────────┐
│ data_pagamento ┆ valor_pagamento │
│ ---            ┆ ---             │
│ date           ┆ f64             │
╞════════════════╪═════════════════╡
│ 2024-05-15     ┆ 0.02956301      │
│ 2024-11-15     ┆ 0.02956301      │
│ 2025-05-15     ┆ 1.02956301      │
└────────────────┴─────────────────┘
Source code in pyield/tpf/titulos/ntnb.py 
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
def fluxos_caixa(
    data_liquidacao: DateLike,
    data_vencimento: DateLike,
) -> pl.DataFrame:
    """
    Gera os fluxos de caixa da NTN-B entre liquidação e vencimento.

    Args:
        data_liquidacao (DateLike): Data de liquidação (exclusiva).
        data_vencimento (DateLike): Data de vencimento.

    Returns:
        pl.DataFrame: DataFrame com as colunas de fluxo.

    Output Columns:
        - data_pagamento (Date): Data contratual do pagamento, sem ajuste para
            dia útil.
        - valor_pagamento (Float64): Valor do pagamento em base 1.

    Notes:
        Para obter as datas efetivas de processamento, use
        ``yd.du.deslocar(..., 0)``.

    Examples:
        >>> from pyield import ntnb
        >>> with pl.Config(float_precision=8):
        ...     ntnb.fluxos_caixa("10-05-2024", "15-05-2025")
        shape: (3, 2)
        ┌────────────────┬─────────────────┐
        │ data_pagamento ┆ valor_pagamento │
        │ ---            ┆ ---             │
        │ date           ┆ f64             │
        ╞════════════════╪═════════════════╡
        │ 2024-05-15     ┆ 0.02956301      │
        │ 2024-11-15     ┆ 0.02956301      │
        │ 2025-05-15     ┆ 1.02956301      │
        └────────────────┴─────────────────┘
    """
    if any_is_empty(data_liquidacao, data_vencimento):
        return pl.DataFrame(
            schema={"data_pagamento": pl.Date, "valor_pagamento": pl.Float64}
        )

    # Obtém as datas de pagamento entre liquidação e vencimento
    liquidacao = conversores.converter_datas(data_liquidacao)
    vencimento = conversores.converter_datas(data_vencimento)
    serie_datas_pagamento = datas_pagamento(liquidacao, vencimento)

    # Retorna DataFrame vazio se não houver pagamentos (liquidação >= vencimento)
    if serie_datas_pagamento.is_empty():
        return pl.DataFrame(
            schema={"data_pagamento": pl.Date, "valor_pagamento": pl.Float64}
        )

    df = pl.DataFrame(
        {"data_pagamento": serie_datas_pagamento},
    ).with_columns(
        pl.when(pl.col("data_pagamento") == vencimento)
        .then(VALOR_FINAL)
        .otherwise(VALOR_CUPOM)
        .alias("valor_pagamento")
    )

    return df

implicitas(data_liquidacao, vencimentos_tir, taxas_tir, vencimentos_nominais, taxas_nominais, *, extrapolar=False)

Calcula a inflação implícita para NTN-B contra uma curva nominal de referência.

A inflação implícita (breakeven) é a que iguala yields reais e nominais, baseada nas taxas zero das NTN-B e na curva nominal informada.

Parameters:

Name Type Description Default
data_liquidacao DateLike

Data de liquidação da operação.

 required
vencimentos_tir DatesLike

Vencimentos das NTN-B usadas como vértices da curva de TIR real.

 required
taxas_tir ArrayLike

TIRs reais observadas das NTN-B correspondentes aos vencimentos informados. A função calcula a curva zero real a partir dessas taxas.

 required
vencimentos_nominais DatesLike

Vencimentos da curva nominal de referência.

 required
taxas_nominais ArrayLike

Taxas da curva nominal de referência. Pode representar DI Futuro, curva soberana prefixada ou outra curva nominal escolhida pelo usuário.

 required
extrapolar bool

Se True, extrapola a curva nominal fora dos vencimentos informados. Se False, vencimentos fora do intervalo da curva nominal retornam valores nulos nas colunas dependentes dessa curva. O padrão é False.

 False

Returns:

Type Description
DataFrame

pl.DataFrame: DataFrame com as taxas calculadas.
Output Columns
  • data_vencimento (Date): Data de vencimento.
  • dias_uteis (Int64): Dias úteis entre liquidação e vencimento.
  • taxa_tir_real (Float64): TIR real da NTN-B recebida na entrada.
  • taxa_zero_real (Float64): Taxa real zero via bootstrap.
  • taxa_nominal (Float64): Taxa nominal interpolada.
  • inflacao_implicita (Float64): Inflação implícita (breakeven).
Notes

A inflação implícita é calculada contra a curva nominal informada. Se essa curva for DI Futuro, o resultado representa a implícita contra DI, não uma inflação soberana prefixada pura.

Examples:

Busca as taxas de NTN-B para uma data de referência. Estas são TIRs e as taxas zero são calculadas a partir delas.

>>> df_ntnb = yd.ntnb.dados("19-06-2026")

Busca as taxas de ajuste do DI Futuro para a mesma data de referência:

>>> df_di = yd.di1.dados("19-06-2026")

Calcula a inflação implícita na data de referência:

>>> yd.ntnb.implicitas(
...     data_liquidacao="19-06-2026",
...     vencimentos_tir=df_ntnb["data_vencimento"],
...     taxas_tir=df_ntnb["taxa_indicativa"],
...     vencimentos_nominais=df_di["data_vencimento"],
...     taxas_nominais=df_di["taxa_ajuste"],
... )
shape: (15, 6)
┌─────────────────┬────────────┬───────────────┬────────────────┬──────────────┬────────────────────┐
│ data_vencimento ┆ dias_uteis ┆ taxa_tir_real ┆ taxa_zero_real ┆ taxa_nominal ┆ inflacao_implicita │
│ ---             ┆ ---        ┆ ---           ┆ ---            ┆ ---          ┆ ---                │
│ date            ┆ i64        ┆ f64           ┆ f64            ┆ f64          ┆ f64                │
╞═════════════════╪════════════╪═══════════════╪════════════════╪══════════════╪════════════════════╡
│ 2026-08-15      ┆ 41         ┆ 0.1115        ┆ 0.1115         ┆ 0.141339     ┆ 0.026846           │
│ 2027-05-15      ┆ 226        ┆ 0.085733      ┆ 0.085642       ┆ 0.145795     ┆ 0.055407           │
│ 2028-08-15      ┆ 541        ┆ 0.089683      ┆ 0.08971        ┆ 0.149149     ┆ 0.054545           │
│ 2029-05-15      ┆ 725        ┆ 0.088171      ┆ 0.088129       ┆ 0.149535     ┆ 0.056432           │
│ 2030-08-15      ┆ 1039       ┆ 0.088766      ┆ 0.088759       ┆ 0.149166     ┆ 0.055482           │
│ …               ┆ …          ┆ …             ┆ …              ┆ …            ┆ …                  │
│ 2040-08-15      ┆ 3548       ┆ 0.078262      ┆ 0.076087       ┆ 0.14591      ┆ 0.064886           │
│ 2045-05-15      ┆ 4735       ┆ 0.076656      ┆ 0.073931       ┆ null         ┆ null               │
│ 2050-08-15      ┆ 6050       ┆ 0.075659      ┆ 0.072435       ┆ null         ┆ null               │
│ 2055-05-15      ┆ 7239       ┆ 0.074658      ┆ 0.07049        ┆ null         ┆ null               │
│ 2060-08-15      ┆ 8556       ┆ 0.07464       ┆ 0.070832       ┆ null         ┆ null               │
└─────────────────┴────────────┴───────────────┴────────────────┴──────────────┴────────────────────┘
Source code in pyield/tpf/titulos/ntnb.py 
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
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
def implicitas(  # noqa: PLR0913
    data_liquidacao: DateLike,
    vencimentos_tir: DatesLike,
    taxas_tir: ArrayLike,
    vencimentos_nominais: DatesLike,
    taxas_nominais: ArrayLike,
    *,
    extrapolar: bool = False,
) -> pl.DataFrame:
    """
    Calcula a inflação implícita para NTN-B contra uma curva nominal de referência.

    A inflação implícita (breakeven) é a que iguala yields reais e nominais,
    baseada nas taxas zero das NTN-B e na curva nominal informada.

    Args:
        data_liquidacao (DateLike): Data de liquidação da operação.
        vencimentos_tir (DatesLike): Vencimentos das NTN-B usadas como vértices
            da curva de TIR real.
        taxas_tir (ArrayLike): TIRs reais observadas das NTN-B correspondentes
            aos vencimentos informados. A função calcula a curva zero real a
            partir dessas taxas.
        vencimentos_nominais (DatesLike): Vencimentos da curva nominal de
            referência.
        taxas_nominais (ArrayLike): Taxas da curva nominal de referência. Pode
            representar DI Futuro, curva soberana prefixada ou outra curva
            nominal escolhida pelo usuário.
        extrapolar (bool): Se `True`, extrapola a curva nominal fora dos
            vencimentos informados. Se `False`, vencimentos fora do intervalo da
            curva nominal retornam valores nulos nas colunas dependentes dessa
            curva. O padrão é `False`.

    Returns:
        pl.DataFrame: DataFrame com as taxas calculadas.

    Output Columns:
        - data_vencimento (Date): Data de vencimento.
        - dias_uteis (Int64): Dias úteis entre liquidação e vencimento.
        - taxa_tir_real (Float64): TIR real da NTN-B recebida na entrada.
        - taxa_zero_real (Float64): Taxa real zero via bootstrap.
        - taxa_nominal (Float64): Taxa nominal interpolada.
        - inflacao_implicita (Float64): Inflação implícita (breakeven).

    Notes:
        A inflação implícita é calculada contra a curva nominal informada. Se
        essa curva for DI Futuro, o resultado representa a implícita contra DI,
        não uma inflação soberana prefixada pura.

    Examples:
        Busca as taxas de NTN-B para uma data de referência.
        Estas são TIRs e as taxas zero são calculadas a partir delas.
        >>> df_ntnb = yd.ntnb.dados("19-06-2026")

        Busca as taxas de ajuste do DI Futuro para a mesma data de referência:
        >>> df_di = yd.di1.dados("19-06-2026")

        Calcula a inflação implícita na data de referência:
        >>> yd.ntnb.implicitas(
        ...     data_liquidacao="19-06-2026",
        ...     vencimentos_tir=df_ntnb["data_vencimento"],
        ...     taxas_tir=df_ntnb["taxa_indicativa"],
        ...     vencimentos_nominais=df_di["data_vencimento"],
        ...     taxas_nominais=df_di["taxa_ajuste"],
        ... )
        shape: (15, 6)
        ┌─────────────────┬────────────┬───────────────┬────────────────┬──────────────┬────────────────────┐
        │ data_vencimento ┆ dias_uteis ┆ taxa_tir_real ┆ taxa_zero_real ┆ taxa_nominal ┆ inflacao_implicita │
        │ ---             ┆ ---        ┆ ---           ┆ ---            ┆ ---          ┆ ---                │
        │ date            ┆ i64        ┆ f64           ┆ f64            ┆ f64          ┆ f64                │
        ╞═════════════════╪════════════╪═══════════════╪════════════════╪══════════════╪════════════════════╡
        │ 2026-08-15      ┆ 41         ┆ 0.1115        ┆ 0.1115         ┆ 0.141339     ┆ 0.026846           │
        │ 2027-05-15      ┆ 226        ┆ 0.085733      ┆ 0.085642       ┆ 0.145795     ┆ 0.055407           │
        │ 2028-08-15      ┆ 541        ┆ 0.089683      ┆ 0.08971        ┆ 0.149149     ┆ 0.054545           │
        │ 2029-05-15      ┆ 725        ┆ 0.088171      ┆ 0.088129       ┆ 0.149535     ┆ 0.056432           │
        │ 2030-08-15      ┆ 1039       ┆ 0.088766      ┆ 0.088759       ┆ 0.149166     ┆ 0.055482           │
        │ …               ┆ …          ┆ …             ┆ …              ┆ …            ┆ …                  │
        │ 2040-08-15      ┆ 3548       ┆ 0.078262      ┆ 0.076087       ┆ 0.14591      ┆ 0.064886           │
        │ 2045-05-15      ┆ 4735       ┆ 0.076656      ┆ 0.073931       ┆ null         ┆ null               │
        │ 2050-08-15      ┆ 6050       ┆ 0.075659      ┆ 0.072435       ┆ null         ┆ null               │
        │ 2055-05-15      ┆ 7239       ┆ 0.074658      ┆ 0.07049        ┆ null         ┆ null               │
        │ 2060-08-15      ┆ 8556       ┆ 0.07464       ┆ 0.070832       ┆ null         ┆ null               │
        └─────────────────┴────────────┴───────────────┴────────────────┴──────────────┴────────────────────┘
    """
    if any_is_empty(
        data_liquidacao,
        vencimentos_tir,
        taxas_tir,
        vencimentos_nominais,
        taxas_nominais,
    ):
        return pl.DataFrame()
    liquidacao, vencimentos_tir, taxas_tir = _validar_entradas_taxas_zero(
        data_liquidacao, vencimentos_tir, taxas_tir
    )
    vencimentos_nominais = conversores.converter_datas(vencimentos_nominais)

    interpolador_ff = interpolador.Interpolador(
        dias_uteis=du.contar(liquidacao, vencimentos_nominais),
        taxas=taxas_nominais,
        metodo="flat_forward",
        extrapolar=extrapolar,
    )
    df_tir = pl.DataFrame(
        data={"data_vencimento": vencimentos_tir, "taxa_tir_real": taxas_tir},
        schema={"data_vencimento": pl.Date, "taxa_tir_real": pl.Float64},
    )
    taxa_nominal_expr = interpolador_ff.interpolar_expr("dias_uteis")
    df = (
        taxas_zero(liquidacao, vencimentos_tir, taxas_tir)
        .join(df_tir, on="data_vencimento", how="left")
        .select(
            "data_vencimento",
            "dias_uteis",
            "taxa_tir_real",
            taxa_zero_real=pl.col("taxa_zero"),
            taxa_nominal=taxa_nominal_expr,
            inflacao_implicita=(taxa_nominal_expr + 1) / (pl.col("taxa_zero") + 1) - 1,
        )
    )

    return df

pu(vna, cotacao)

Calcula o PU da NTN-B pela metodologia da STN para leilões primários.

Parameters:

Name Type Description Default
vna float | Decimal

Valor nominal atualizado (VNA).

 required
cotacao float | Decimal

Fator de cotação da NTN-B em base 1.

 required

Returns:

Name Type Description
Decimal Decimal

Preço da NTN-B truncado em 6 casas decimais.
References
  • Secretaria do Tesouro Nacional. Metodologia de Cálculo dos Títulos Públicos Federais Ofertados nos Leilões Primários. https://crdcj.github.io/PYield/referencias/metodologia-calculo-tpf-stn/

Examples:

>>> from pyield import ntnb
>>> ntnb.pu(4299.160173, 0.993651)
Decimal('4271.864805')
>>> ntnb.pu(4315.498383, 1.006409)
Decimal('4343.156412')
>>> ntnb.pu(1728.4611369, 0.9708139)
Decimal('1678.012540')
Source code in pyield/tpf/titulos/ntnb.py 
339
340
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
def pu(
    vna: float | Decimal,
    cotacao: float | Decimal,
) -> Decimal:
    """
    Calcula o PU da NTN-B pela metodologia da STN para leilões primários.

    Args:
        vna: Valor nominal atualizado (VNA).
        cotacao: Fator de cotação da NTN-B em base 1.

    Returns:
        Decimal: Preço da NTN-B truncado em 6 casas decimais.

    References:
        - Secretaria do Tesouro Nacional. Metodologia de Cálculo dos Títulos
          Públicos Federais Ofertados nos Leilões Primários.
          https://crdcj.github.io/PYield/referencias/metodologia-calculo-tpf-stn/

    Examples:
        >>> from pyield import ntnb
        >>> ntnb.pu(4299.160173, 0.993651)
        Decimal('4271.864805')
        >>> ntnb.pu(4315.498383, 1.006409)
        Decimal('4343.156412')
        >>> ntnb.pu(1728.4611369, 0.9708139)
        Decimal('1678.012540')
    """
    return _calcular_pu(vna, cotacao)

taxa(data_liquidacao, data_vencimento, vna, pu)

Calcula a TIR implícita de uma NTN-B a partir do preço (PU).

A função inverte numericamente a cadeia pu(vna, cotacao(...)), encontrando a taxa que zera a diferença entre o preço calculado e o informado.

Parameters:

Name Type Description Default
data_liquidacao DateLike

Data de liquidação.

 required
data_vencimento DateLike

Data de vencimento.

 required
vna float | Decimal

Valor nominal atualizado (VNA).

 required
pu float | Decimal

Preço unitário (PU) do título.

 required

Returns:

Name Type Description
float float

TIR implícita em formato decimal, truncada em oito casas decimais (seis casas em termos percentuais). Retorna NaN em caso de erro.

Examples:

>>> from pyield import ntnb
>>> ntnb.taxa("31-05-2024", "15-05-2035", 4299.160173, 4271.864805)
0.06149003
>>> ntnb.taxa("15-08-2024", "15-08-2032", 4315.498383, 4343.156412)
0.05929003
>>> ntnb.taxa("21-05-2008", "15-08-2010", 1728.461136, 1781.867128)
0.0523457
Source code in pyield/tpf/titulos/ntnb.py 
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
def taxa(
    data_liquidacao: DateLike,
    data_vencimento: DateLike,
    vna: float | Decimal,
    pu: float | Decimal,
) -> float:
    """
    Calcula a TIR implícita de uma NTN-B a partir do preço (PU).

    A função inverte numericamente a cadeia ``pu(vna, cotacao(...))``,
    encontrando a taxa que zera a diferença entre o preço calculado e o
    informado.

    Args:
        data_liquidacao (DateLike): Data de liquidação.
        data_vencimento (DateLike): Data de vencimento.
        vna: Valor nominal atualizado (VNA).
        pu: Preço unitário (PU) do título.

    Returns:
        float: TIR implícita em formato decimal, truncada em oito casas
            decimais (seis casas em termos percentuais). Retorna NaN em
            caso de erro.

    Examples:
        >>> from pyield import ntnb
        >>> ntnb.taxa("31-05-2024", "15-05-2035", 4299.160173, 4271.864805)
        0.06149003
        >>> ntnb.taxa("15-08-2024", "15-08-2032", 4315.498383, 4343.156412)
        0.05929003
        >>> ntnb.taxa("21-05-2008", "15-08-2010", 1728.461136, 1781.867128)
        0.0523457
    """
    if any_is_empty(data_liquidacao, data_vencimento, vna, pu):
        return float("nan")

    pu_float = float(pu)
    if pu_float <= 0:
        return float("nan")

    def diferenca_preco(taxa_encontrada: float) -> float:
        cotacao_calculada = cotacao(data_liquidacao, data_vencimento, taxa_encontrada)
        return float(_calcular_pu(vna, cotacao_calculada)) - pu_float

    taxa_encontrada = utils.encontrar_raiz(diferenca_preco)
    return utils.truncar(taxa_encontrada, 8)

taxas_zero(data_liquidacao, vencimentos, taxas, incluir_cupons=False)

Calcula as taxas zero da NTN-B usando bootstrap.

O bootstrap determina as taxas zero a partir dos yields dos títulos, resolvendo iterativamente as taxas que descontam os fluxos ao preço.

Parameters:

Name Type Description Default
data_liquidacao DateLike

Data de liquidação.

 required
vencimentos DatesLike

Datas de vencimento dos títulos.

 required
taxas ArrayLike

TIRs correspondentes em formato decimal (ex.: 0.10 para 10%).

 required
incluir_cupons bool

Se True, inclui datas intermediárias de cupom. Padrão False.

 False

Returns:

Type Description
DataFrame

pl.DataFrame: DataFrame com as taxas zero.
Output Columns
  • data_vencimento (Date): Data de vencimento.
  • dias_uteis (Int64): Dias úteis entre liquidação e vencimento.
  • taxa_zero (Float64): Taxa zero (real).

Examples:

>>> from pyield import ntnb
>>> # Busca as taxas de NTN-B para uma data de referência
>>> df = ntnb.dados("16-08-2024")
>>> # Calcula as taxas zero considerando a liquidação na data de referência
>>> ntnb.taxas_zero(
...     data_liquidacao="16-08-2024",
...     vencimentos=df["data_vencimento"],
...     taxas=df["taxa_indicativa"],
... )
shape: (14, 3)
┌─────────────────┬────────────┬───────────┐
│ data_vencimento ┆ dias_uteis ┆ taxa_zero │
│ ---             ┆ ---        ┆ ---       │
│ date            ┆ i64        ┆ f64       │
╞═════════════════╪════════════╪═══════════╡
│ 2025-05-15      ┆ 185        ┆ 0.063893  │
│ 2026-08-15      ┆ 502        ┆ 0.066141  │
│ 2027-05-15      ┆ 687        ┆ 0.064087  │
│ 2028-08-15      ┆ 1002       ┆ 0.063057  │
│ 2029-05-15      ┆ 1186       ┆ 0.061458  │
│ …               ┆ …          ┆ …         │
│ 2040-08-15      ┆ 4009       ┆ 0.058326  │
│ 2045-05-15      ┆ 5196       ┆ 0.060371  │
│ 2050-08-15      ┆ 6511       ┆ 0.060772  │
│ 2055-05-15      ┆ 7700       ┆ 0.059909  │
│ 2060-08-15      ┆ 9017       ┆ 0.060652  │
└─────────────────┴────────────┴───────────┘

Caso a liquidação ocorra logo após uma data de cupom, o valor presente dos cupons anteriores pode ser zero:

>>> df = ntnb.dados("15-05-2026")
>>> ntnb.taxas_zero(
...     data_liquidacao="18-05-2026",
...     vencimentos=df["data_vencimento"],
...     taxas=df["taxa_indicativa"],
...     incluir_cupons=True,
... )
shape: (137, 3)
┌─────────────────┬────────────┬───────────┐
│ data_vencimento ┆ dias_uteis ┆ taxa_zero │
│ ---             ┆ ---        ┆ ---       │
│ date            ┆ i64        ┆ f64       │
╞═════════════════╪════════════╪═══════════╡
│ 2026-08-15      ┆ 64         ┆ 0.102013  │
│ 2026-11-15      ┆ 126        ┆ 0.088186  │
│ 2027-02-15      ┆ 186        ┆ 0.083431  │
│ 2027-05-15      ┆ 249        ┆ 0.081096  │
│ 2027-08-15      ┆ 313        ┆ 0.081005  │
│ …               ┆ …          ┆ …         │
│ 2059-08-15      ┆ 8326       ┆ 0.070508  │
│ 2059-11-15      ┆ 8392       ┆ 0.070524  │
│ 2060-02-15      ┆ 8454       ┆ 0.07053   │
│ 2060-05-15      ┆ 8515       ┆ 0.070547  │
│ 2060-08-15      ┆ 8579       ┆ 0.070553  │
└─────────────────┴────────────┴───────────┘
Notes

O cálculo considera: - Mapear todas as datas de pagamento até o último vencimento. - Interpolar as TIRs nas datas intermediárias. - Calcular a cotação da NTN-B para cada vencimento. - Calcular as taxas zero reais.

Source code in pyield/tpf/titulos/ntnb.py 
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
518
519
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
def taxas_zero(
    data_liquidacao: DateLike,
    vencimentos: DatesLike,
    taxas: ArrayLike,
    incluir_cupons: bool = False,
) -> pl.DataFrame:
    """
    Calcula as taxas zero da NTN-B usando bootstrap.

    O bootstrap determina as taxas zero a partir dos yields dos títulos,
    resolvendo iterativamente as taxas que descontam os fluxos ao preço.

    Args:
        data_liquidacao (DateLike): Data de liquidação.
        vencimentos (DatesLike): Datas de vencimento dos títulos.
        taxas (ArrayLike): TIRs correspondentes em formato decimal
            (ex.: 0.10 para 10%).
        incluir_cupons (bool, optional): Se True, inclui datas intermediárias de cupom.
            Padrão False.

    Returns:
        pl.DataFrame: DataFrame com as taxas zero.

    Output Columns:
        - data_vencimento (Date): Data de vencimento.
        - dias_uteis (Int64): Dias úteis entre liquidação e vencimento.
        - taxa_zero (Float64): Taxa zero (real).

    Examples:
        >>> from pyield import ntnb
        >>> # Busca as taxas de NTN-B para uma data de referência
        >>> df = ntnb.dados("16-08-2024")
        >>> # Calcula as taxas zero considerando a liquidação na data de referência
        >>> ntnb.taxas_zero(
        ...     data_liquidacao="16-08-2024",
        ...     vencimentos=df["data_vencimento"],
        ...     taxas=df["taxa_indicativa"],
        ... )
        shape: (14, 3)
        ┌─────────────────┬────────────┬───────────┐
        │ data_vencimento ┆ dias_uteis ┆ taxa_zero │
        │ ---             ┆ ---        ┆ ---       │
        │ date            ┆ i64        ┆ f64       │
        ╞═════════════════╪════════════╪═══════════╡
        │ 2025-05-15      ┆ 185        ┆ 0.063893  │
        │ 2026-08-15      ┆ 502        ┆ 0.066141  │
        │ 2027-05-15      ┆ 687        ┆ 0.064087  │
        │ 2028-08-15      ┆ 1002       ┆ 0.063057  │
        │ 2029-05-15      ┆ 1186       ┆ 0.061458  │
        │ …               ┆ …          ┆ …         │
        │ 2040-08-15      ┆ 4009       ┆ 0.058326  │
        │ 2045-05-15      ┆ 5196       ┆ 0.060371  │
        │ 2050-08-15      ┆ 6511       ┆ 0.060772  │
        │ 2055-05-15      ┆ 7700       ┆ 0.059909  │
        │ 2060-08-15      ┆ 9017       ┆ 0.060652  │
        └─────────────────┴────────────┴───────────┘

        Caso a liquidação ocorra logo após uma data de cupom, o valor presente
        dos cupons anteriores pode ser zero:
        >>> df = ntnb.dados("15-05-2026")
        >>> ntnb.taxas_zero(
        ...     data_liquidacao="18-05-2026",
        ...     vencimentos=df["data_vencimento"],
        ...     taxas=df["taxa_indicativa"],
        ...     incluir_cupons=True,
        ... )
        shape: (137, 3)
        ┌─────────────────┬────────────┬───────────┐
        │ data_vencimento ┆ dias_uteis ┆ taxa_zero │
        │ ---             ┆ ---        ┆ ---       │
        │ date            ┆ i64        ┆ f64       │
        ╞═════════════════╪════════════╪═══════════╡
        │ 2026-08-15      ┆ 64         ┆ 0.102013  │
        │ 2026-11-15      ┆ 126        ┆ 0.088186  │
        │ 2027-02-15      ┆ 186        ┆ 0.083431  │
        │ 2027-05-15      ┆ 249        ┆ 0.081096  │
        │ 2027-08-15      ┆ 313        ┆ 0.081005  │
        │ …               ┆ …          ┆ …         │
        │ 2059-08-15      ┆ 8326       ┆ 0.070508  │
        │ 2059-11-15      ┆ 8392       ┆ 0.070524  │
        │ 2060-02-15      ┆ 8454       ┆ 0.07053   │
        │ 2060-05-15      ┆ 8515       ┆ 0.070547  │
        │ 2060-08-15      ┆ 8579       ┆ 0.070553  │
        └─────────────────┴────────────┴───────────┘

    Notes:
        O cálculo considera:
        - Mapear todas as datas de pagamento até o último vencimento.
        - Interpolar as TIRs nas datas intermediárias.
        - Calcular a cotação da NTN-B para cada vencimento.
        - Calcular as taxas zero reais.
    """
    if any_is_empty(data_liquidacao, vencimentos, taxas):
        return pl.DataFrame()

    data_liquidacao, vencimentos, taxas = _validar_entradas_taxas_zero(
        data_liquidacao, vencimentos, taxas
    )

    df = _criar_df_bootstrap(data_liquidacao, taxas, vencimentos)

    # Bootstrap para calcular taxas zero
    linhas = df.to_dicts()
    primeiro_vencimento = vencimentos.min()
    for linha in linhas:
        vencimento = linha["data_vencimento"]

        # Taxas zero <= primeiro vencimento são TIR por definição
        if vencimento <= primeiro_vencimento:
            taxa_zero = linha["taxa_tir"]
            df = _atualizar_taxa_zero(df, vencimento, taxa_zero)
            continue

        # Calcula taxa zero para o vencimento corrente
        valor_presente_cupons = _calcular_valor_presente_cupons(
            df, data_liquidacao, vencimento
        )
        preco_titulo = float(
            cotacao(data_liquidacao, vencimento, linha["taxa_tir"])
        )
        fator_preco = VALOR_FINAL / (preco_titulo - valor_presente_cupons)
        taxa_zero = fator_preco ** (1 / linha["anos_uteis"]) - 1

        df = _atualizar_taxa_zero(df, vencimento, taxa_zero)

    if not incluir_cupons:
        df = df.filter(pl.col("data_vencimento").is_in(vencimentos.to_list()))
    return df.select(["data_vencimento", "dias_uteis", "taxa_zero"])

vencimentos(data)

Busca os vencimentos de NTN-B 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-B.

Examples:

>>> from pyield import ntnb
>>> ntnb.vencimentos("16-08-2024")
shape: (14,)
Series: 'data_vencimento' [date]
[
    2025-05-15
    2026-08-15
    2027-05-15
    2028-08-15
    2029-05-15
    …
    2040-08-15
    2045-05-15
    2050-08-15
    2055-05-15
    2060-08-15
]
Source code in pyield/tpf/titulos/ntnb.py 
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
def vencimentos(data: DateLike) -> pl.Series:
    """
    Busca os vencimentos de NTN-B disponíveis para a data de referência.

    Args:
        data (DateLike): Data da consulta.

    Returns:
        pl.Series: Série de datas de vencimento de NTN-B.

    Examples:
        >>> from pyield import ntnb
        >>> ntnb.vencimentos("16-08-2024")
        shape: (14,)
        Series: 'data_vencimento' [date]
        [
            2025-05-15
            2026-08-15
            2027-05-15
            2028-08-15
            2029-05-15
            …
            2040-08-15
            2045-05-15
            2050-08-15
            2055-05-15
            2060-08-15
        ]
    """
    return dados(data)["data_vencimento"]