PYield 0.7.7__tar.gz → 0.7.8__tar.gz

{pyield-0.7.7 → pyield-0.7.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PYield
-Version: 0.7.7
+Version: 0.7.8
 Summary: A Python library for analysis of fixed income instruments in Brazil
 Keywords: fixed-income, brazil, finance, analysis, bonds
 Author-Email: Carlos Carvalho <cr.cj@outlook.com>
@@ -32,13 +32,13 @@ Classifier: Intended Audience :: Financial and Insurance Industry
 Classifier: Topic :: Office/Business :: Financial :: Investment
 Project-URL: Source, https://github.com/crdcj/PYield
 Requires-Python: >=3.11
-Requires-Dist: requests
 Requires-Dist: pandas>=2.0.0
 Requires-Dist: numpy
 Requires-Dist: beautifulsoup4
 Requires-Dist: html5lib
 Requires-Dist: lxml
 Requires-Dist: python-calamine>=0.2.0
+Requires-Dist: requests>=2.31.0
 Description-Content-Type: text/markdown
 
 [![PyPI version](https://img.shields.io/pypi/v/pyield.svg)](https://pypi.python.org/pypi/pyield)
@@ -101,7 +101,7 @@ dtype: datetime64[ns]
 ```python
 # Fetch current DI Futures data from B3 (15 minutes delay)
 >>> yd.fetch_asset(asset_code="DI1")
-TradeTimestamp      TickerSymbol ExpirationDate BDaysToExp ... MaxRate LastAskRate LastBidRate LastRate
+TradeTimestamp      TickerSymbol ExpirationDate BDaysToExp ... MaxRate LastAskRate LastBidRate CurrentRate
 2024-04-21 13:37:39       DI1K24     2024-05-02          7 ... 0.10660     0.10652     0.10660  0.10660
 2024-04-21 13:37:39       DI1M24     2024-06-03         28 ... 0.10518     0.10510     0.10516  0.10518
 2024-04-21 13:37:39       DI1N24     2024-07-01         48 ... 0.10480     0.10456     0.10462  0.10460
@@ -158,11 +158,11 @@ BondType ReferenceDate MaturityDate  DISpread
 ```python
 # Fetch the SELIC target rate from the Central Bank of Brazil
 >>> yd.fetch_indicator(indicator_code="SELIC", reference_date='2024-04-12')
-10.75
+0.1075  # 10.75%
 
 # Fetch the IPCA monthly inflation rate from IBGE
 >>> yd.fetch_indicator(indicator_code="IPCA", reference_date='2024-03-18')
-0.16
+0.16  # 0.16%
 
 # If no data is yet available for the indicator, the function returns None
 >>> yd.fetch_indicator(indicator_code="IPCA", reference_date='2024-04-10')
@@ -178,9 +178,9 @@ IndicatorProjection(
     last_updated=Timestamp('2024-04-19 18:55:00'),
     reference_month_ts=Timestamp('2024-04-01 00:00:00'),
     reference_month_br='ABR/2024',
-    projected_value=0.0035
+    projected_value=0.0035  # 0.35%
 )
 >>> ipca.projected_value
-0.0035
+0.0035  # 0.35%
 ```
 

{pyield-0.7.7 → pyield-0.7.8}/README.md

@@ -58,7 +58,7 @@ dtype: datetime64[ns]
 ```python
 # Fetch current DI Futures data from B3 (15 minutes delay)
 >>> yd.fetch_asset(asset_code="DI1")
-TradeTimestamp      TickerSymbol ExpirationDate BDaysToExp ... MaxRate LastAskRate LastBidRate LastRate
+TradeTimestamp      TickerSymbol ExpirationDate BDaysToExp ... MaxRate LastAskRate LastBidRate CurrentRate
 2024-04-21 13:37:39       DI1K24     2024-05-02          7 ... 0.10660     0.10652     0.10660  0.10660
 2024-04-21 13:37:39       DI1M24     2024-06-03         28 ... 0.10518     0.10510     0.10516  0.10518
 2024-04-21 13:37:39       DI1N24     2024-07-01         48 ... 0.10480     0.10456     0.10462  0.10460
@@ -115,11 +115,11 @@ BondType ReferenceDate MaturityDate  DISpread
 ```python
 # Fetch the SELIC target rate from the Central Bank of Brazil
 >>> yd.fetch_indicator(indicator_code="SELIC", reference_date='2024-04-12')
-10.75
+0.1075  # 10.75%
 
 # Fetch the IPCA monthly inflation rate from IBGE
 >>> yd.fetch_indicator(indicator_code="IPCA", reference_date='2024-03-18')
-0.16
+0.16  # 0.16%
 
 # If no data is yet available for the indicator, the function returns None
 >>> yd.fetch_indicator(indicator_code="IPCA", reference_date='2024-04-10')
@@ -135,9 +135,9 @@ IndicatorProjection(
     last_updated=Timestamp('2024-04-19 18:55:00'),
     reference_month_ts=Timestamp('2024-04-01 00:00:00'),
     reference_month_br='ABR/2024',
-    projected_value=0.0035
+    projected_value=0.0035  # 0.35%
 )
 >>> ipca.projected_value
-0.0035
+0.0035  # 0.35%
 ```
 

pyield-0.7.8/pyield/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.7.8"

{pyield-0.7.7 → pyield-0.7.8}/pyield/data_access.py

@@ -1,9 +1,10 @@
 import pandas as pd
 
-from . import futures as ft
 from . import indicators as it
 from . import projections as pr
 from . import treasuries as tr
+from .futures import historical as fh
+from .futures import intraday as fi
 from .utils import _normalize_date
 
 
@@ -24,6 +25,7 @@ def fetch_asset(
             - "DI1": One-day Interbank Deposit Futures (Futuro de DI) from B3.
             - "DDI": DI x U.S. Dollar Spread Futures (Futuro de Cupom Cambial) from B3.
             - "FRC": Forward Rate Agreement (FRA) from B3.
+            - "DAP": DI x IPCA Spread Futures
         reference_date (str | pd.Timestamp | None): The reference date for which data is
             fetched. Defaults to the last business day if None.
         **kwargs: Additional keyword arguments, specifically:
@@ -43,24 +45,30 @@ def fetch_asset(
     return_raw = kwargs.get("return_raw", False)
     normalized_date = _normalize_date(reference_date)
 
+    today = pd.Timestamp.today().normalize()
+    if normalized_date == today:
+        return fi.fetch_intraday(future_code=asset_code.upper())
+
     if asset_code.lower() == "trb":
         return tr.fetch_bonds(reference_date=normalized_date, return_raw=return_raw)
-    elif asset_code.lower() in ["ltn", "lft", "ntn-f", "ntn-b"]:
+
+    if asset_code.lower() in ["ltn", "lft", "ntn-f", "ntn-b"]:
         df = tr.fetch_bonds(reference_date=normalized_date)
         return df.query(f"BondType == '{asset_code.upper()}'")
 
-    elif asset_code.lower() == "di1":
-        today = pd.Timestamp.today().normalize()
-        if normalized_date == today:
-            return ft.fetch_last_di()
-        else:
-            return ft.fetch_past_di(trade_date=normalized_date, return_raw=return_raw)
-    elif asset_code.lower() == "ddi":
-        return ft.fetch_past_ddi(trade_date=normalized_date, return_raw=return_raw)
-    elif asset_code.lower() == "frc":
-        return ft.fetch_past_frc(trade_date=normalized_date, return_raw=return_raw)
-    else:
-        raise ValueError("Asset type not supported.")
+    if asset_code.lower() == "di1":
+        return fh.fetch_di(trade_date=normalized_date, return_raw=return_raw)
+
+    if asset_code.lower() == "ddi":
+        return fh.fetch_ddi(trade_date=normalized_date, return_raw=return_raw)
+
+    if asset_code.lower() == "frc":
+        return fh.fetch_frc(trade_date=normalized_date, return_raw=return_raw)
+
+    if asset_code.lower() == "dap":
+        return fh.fetch_dap(trade_date=normalized_date, return_raw=return_raw)
+
+    raise ValueError("Asset type not supported.")
 
 
 def fetch_indicator(

pyield-0.7.8/pyield/futures/historical/__init__.py

@@ -0,0 +1,6 @@
+from .dap import fetch_dap
+from .ddi import fetch_ddi
+from .di import fetch_di
+from .frc import fetch_frc
+
+__all__ = ["fetch_di", "fetch_ddi", "fetch_frc", "fetch_dap"]

{pyield-0.7.7/pyield/futures → pyield-0.7.8/pyield/futures/historical}/common.py

@@ -3,29 +3,7 @@ import io
 import pandas as pd
 import requests
 
-from .. import bday
-
-COLUMNS_MAPPING = {
-    "VENCTO": "ExpirationCode",
-    "CONTR. ABERT.(1)": "OpenContracts",  # At the start of the day
-    "CONTR. FECH.(2)": "OpenContractsEndSession",  # At the end of the day
-    "NÚM. NEGOC.": "TradeCount",
-    "CONTR. NEGOC.": "TradeVolume",
-    "VOL.": "FinancialVolume",
-    "AJUSTE": "SettlementPrice",
-    "AJUSTE ANTER. (3)": "PrevSettlementRate",
-    "AJUSTE CORRIG. (4)": "AdjSettlementRate",
-    "AJUSTE  DE REF.": "SettlementRate",  # FRC
-    "PREÇO MÍN.": "MinRate",
-    "PREÇO MÉD.": "AvgRate",
-    "PREÇO MÁX.": "MaxRate",
-    "PREÇO ABERTU.": "FirstRate",
-    "ÚLT. PREÇO": "CloseRate",
-    "VAR. PTOS.": "PointsVariation",
-    # Attention: bid/ask rates are inverted
-    "ÚLT.OF. COMPRA": "CloseAskRate",
-    "ÚLT.OF. VENDA": "CloseBidRate",
-}
+from ... import bday
 
 
 def get_expiration_date(expiration_code: str) -> pd.Timestamp:
@@ -153,7 +131,28 @@ def get_old_expiration_date(
         return pd.NaT  # type: ignore
 
 
-def fetch_past_raw_df(asset_code: str, trade_date: pd.Timestamp) -> pd.DataFrame:
+def convert_prices_to_rates(
+    prices: pd.Series, days_to_expiration: pd.Series, count_convention: int
+) -> pd.Series:
+    """
+    Internal function to convert DI futures prices to rates.
+
+    Args:
+        prices (pd.Series): The futures prices to be converted.
+        days_to_expiration (pd.Series): The number of days to expiration for each price.
+        count_convention (int): The count convention for the DI futures contract.
+            Normally, it is 252 business days or 360 calendar days.
+
+    Returns:
+        pd.Series: A pd.Series containing the futures rates.
+    """
+    rates = (100_000 / prices) ** (count_convention / days_to_expiration) - 1
+
+    # Round to 5 (3 in %) dec. places (contract's current max. precision)
+    return rates.round(5)
+
+
+def fetch_raw_df(asset_code: str, trade_date: pd.Timestamp) -> pd.DataFrame:
     """
     Fetch the historical futures data from B3 for a specific trade date. If the data is
     not available, an empty DataFrame is returned.
@@ -199,60 +198,7 @@ def fetch_past_raw_df(asset_code: str, trade_date: pd.Timestamp) -> pd.DataFrame
     return df
 
 
-def fetch_last_raw_df(future_code: str) -> pd.DataFrame:
-    """
-    Fetch the latest data for a given future code from B3 derivatives quotation API.
-
-    Args:
-    future_code (str): The future code to fetch data for.
-
-    Returns:
-    pd.DataFrame: A DataFrame containing the normalized and cleaned data from the API.
-
-    Raises:
-    Exception: An exception is raised if the data fetch operation fails.
-    """
-
-    url = f"https://cotacao.b3.com.br/mds/api/v1/DerivativeQuotation/{future_code}"
-
-    try:
-        r = requests.get(url)
-        r.raise_for_status()  # Check for HTTP request errors
-    except requests.exceptions.RequestException:
-        raise Exception(f"Failed to fetch data for {future_code}.") from None
-
-    r.encoding = "utf-8"  # Explicitly set response encoding to utf-8 for consistency
-
-    # Normalize JSON response into a flat table
-    df = pd.json_normalize(r.json()["Scty"])
-
-    # Clean and reformat the DataFrame columns
-    df.columns = (df.columns
-        .str.replace("SctyQtn.", "")
-        .str.replace("asset.AsstSummry.", "")
-    )  # fmt: skip
-    df.drop(columns=["desc", "asset.code", "mkt.cd"], inplace=True)
-
-    # Convert maturity codes to datetime and drop rows with missing values
-    df["mtrtyCode"] = pd.to_datetime(df["mtrtyCode"], errors="coerce")
-    df.dropna(subset=["mtrtyCode"], inplace=True)
-
-    # Sort the DataFrame by maturity code and reset the index
-    df.sort_values("mtrtyCode", inplace=True, ignore_index=True)
-
-    # Get current date and time
-    now = pd.Timestamp.now().round("s")
-    # Subtract 15 minutes from the current time to account for API delay
-    trade_ts = now - pd.Timedelta(minutes=15)
-    df["TradeTimestamp"] = trade_ts
-
-    # Convert DataFrame to use nullable data types for better type consistency
-    df = df.convert_dtypes(dtype_backend="numpy_nullable")
-
-    return df
-
-
-def rename_columns(df: pd.DataFrame):
+def rename_columns(df: pd.DataFrame) -> pd.DataFrame:
     all_columns = {
         "VENCTO": "ExpirationCode",
         "CONTR. ABERT.(1)": "OpenContracts",  # At the start of the day
@@ -274,13 +220,39 @@ def rename_columns(df: pd.DataFrame):
         "ÚLT.OF. COMPRA": "CloseAskRate",
         "ÚLT.OF. VENDA": "CloseBidRate",
     }
-    rename_dict = {}
-    for col in all_columns:
-        if col in df.columns:
-            rename_dict[col] = all_columns[col]
+    rename_dict = {c: all_columns[c] for c in all_columns if c in df.columns}
     return df.rename(columns=rename_dict)
 
 
+def process_raw_df(
+    df: pd.DataFrame, trade_date: pd.Timestamp, asset_code: str
+) -> pd.DataFrame:
+    df = rename_columns(df)
+
+    df["TradeDate"] = trade_date
+    # Convert to datetime64[ns] since it is pandas default type for timestamps
+    df["TradeDate"] = df["TradeDate"].astype("datetime64[ns]")
+
+    df["TickerSymbol"] = asset_code + df["ExpirationCode"]
+
+    # Contract code format was changed in 22/05/2006
+    if trade_date < pd.Timestamp("2006-05-22"):
+        df["ExpirationDate"] = df["ExpirationCode"].apply(
+            get_old_expiration_date, args=(trade_date,)
+        )
+    else:
+        df["ExpirationDate"] = df["ExpirationCode"].apply(get_expiration_date)
+
+    # Columns where 0 means NaN
+    cols_with_nan = [col for col in df.columns if "Rate" in col]
+    if "SettlementPrice" in df.columns:
+        cols_with_nan.append("SettlementPrice")
+    # Replace 0 with NaN in these columns
+    df[cols_with_nan] = df[cols_with_nan].replace(0, pd.NA)
+
+    return df
+
+
 def reorder_columns(df: pd.DataFrame):
     all_columns = [
         "TradeDate",
@@ -305,8 +277,5 @@ def reorder_columns(df: pd.DataFrame):
         "CloseBidRate",
         "CloseRate",
     ]
-    reordered_columns = []
-    for col in all_columns:
-        if col in df.columns:
-            reordered_columns.append(col)
+    reordered_columns = [col for col in all_columns if col in df.columns]
     return df[reordered_columns]

pyield-0.7.8/pyield/futures/historical/dap.py

@@ -0,0 +1,62 @@
+import pandas as pd
+
+from ... import bday as bd
+from . import common as cm
+
+
+def _process_df(df: pd.DataFrame, trade_date: pd.Timestamp) -> pd.DataFrame:
+    """
+    Internal function to process and transform raw DI futures data.
+
+    Args:
+        df (pd.DataFrame): the raw DI DataFrame.
+        trade_date: a datetime-like object representing the trade date.
+
+    Returns:
+        pd.DataFrame: Processed and transformed data as a Pandas pd.DataFrame.
+    """
+    df["BDaysToExp"] = bd.count_bdays(trade_date, df["ExpirationDate"])
+
+    # Remove expired contracts
+    df.query("BDaysToExp > 0", inplace=True)
+
+    rate_cols = [col for col in df.columns if "Rate" in col]
+    # Remove % and round to 5 (3 in %) dec. places in rate columns
+    df[rate_cols] = df[rate_cols].div(100).round(5)
+
+    # Calculate SettlementRate
+    df["SettlementRate"] = cm.convert_prices_to_rates(
+        prices=df["SettlementPrice"],
+        days_to_expiration=df["BDaysToExp"],
+        count_convention=252,
+    )
+
+    return df
+
+
+def fetch_dap(trade_date: pd.Timestamp, return_raw: bool = False) -> pd.DataFrame:
+    """
+    Fetchs the DI futures data for a given date from B3.
+
+    This function fetches and processes the DI futures data from B3 for a specific
+    trade date. It's the primary external interface for accessing DI data. If the data
+    is not available, an empty DataFrame is returned.
+
+    Args:
+        trade_date (pd.Timestamp): The trade date to fetch the DI futures data.
+        return_raw (bool): If True, returns the raw data as a Pandas pd.DataFrame.
+            Defaults to False.
+
+    Returns:
+        pd.DataFrame: A Pandas pd.DataFrame containing processed DI futures data.
+
+    Notes:
+        - BDaysToExp: number of business days to ExpirationDate.
+        - OpenContracts: number of open contracts at the start of the trading day.
+    """
+    df_raw = cm.fetch_raw_df(asset_code="DI1", trade_date=trade_date)
+    if return_raw or df_raw.empty:
+        return df_raw
+    df = cm.process_raw_df(df_raw, trade_date, asset_code="DI1")
+    df = _process_df(df, trade_date)
+    return cm.reorder_columns(df)

{pyield-0.7.7/pyield/futures → pyield-0.7.8/pyield/futures/historical}/ddi.py

@@ -19,7 +19,7 @@ def _convert_prices_to_rates(prices: pd.Series, n_days: pd.Series) -> pd.Series:
     return rates.round(5)
 
 
-def _process_raw_df(df: pd.DataFrame, trade_date: pd.Timestamp) -> pd.DataFrame:
+def _process_ddi_df(df: pd.DataFrame, trade_date: pd.Timestamp) -> pd.DataFrame:
     """
     Internal function to process and transform raw DI futures data.
 
@@ -30,22 +30,8 @@ def _process_raw_df(df: pd.DataFrame, trade_date: pd.Timestamp) -> pd.DataFrame:
     Returns:
         pd.DataFrame: Processed and transformed data as a Pandas pd.DataFrame.
     """
-    df = cm.rename_columns(df)
-
-    df["TradeDate"] = trade_date
-    # Convert to datetime64[ns] since it is pandas default type for timestamps
-    df["TradeDate"] = df["TradeDate"].astype("datetime64[ns]")
-
-    # Contract code format was changed in 22/05/2006
-    if trade_date < pd.Timestamp("2006-05-22"):
-        df["ExpirationDate"] = df["ExpirationCode"].apply(
-            cm.get_old_expiration_date, args=(trade_date,)
-        )
-    else:
-        df["ExpirationDate"] = df["ExpirationCode"].apply(cm.get_expiration_date)
-
     df["DaysToExp"] = (df["ExpirationDate"] - trade_date).dt.days
-    # Convert to nullable integer, since other columns use this data type
+    # Convert to nullable integer, since it is the default type in the library
     df["DaysToExp"] = df["DaysToExp"].astype(pd.Int64Dtype())
 
     # Remove expired contracts
@@ -53,10 +39,6 @@ def _process_raw_df(df: pd.DataFrame, trade_date: pd.Timestamp) -> pd.DataFrame:
 
     # Columns where 0 means NaN
     rate_cols = [col for col in df.columns if "Rate" in col]
-    cols_with_nan = rate_cols + ["SettlementPrice"]
-    # Replace 0 with NaN in these columns
-    df[cols_with_nan] = df[cols_with_nan].replace(0, pd.NA)
-
     df[rate_cols] = df[rate_cols].div(100).round(5)
 
     # Calculate SettlementRate
@@ -64,15 +46,10 @@ def _process_raw_df(df: pd.DataFrame, trade_date: pd.Timestamp) -> pd.DataFrame:
         df["SettlementPrice"], df["DaysToExp"]
     )
 
-    df["TickerSymbol"] = "DI1" + df["ExpirationCode"]
-
-    # Filter and order columns
-    df = cm.reorder_columns(df)
-
     return df
 
 
-def fetch_past_ddi(trade_date: pd.Timestamp, return_raw: bool = False) -> pd.DataFrame:
+def fetch_ddi(trade_date: pd.Timestamp, return_raw: bool = False) -> pd.DataFrame:
     """
     Fetchs the DDI futures data for a given date from B3.
 
@@ -95,7 +72,9 @@ def fetch_past_ddi(trade_date: pd.Timestamp, return_raw: bool = False) -> pd.Dat
         - DaysToExp: number of business days to ExpirationDate.
         - OpenContracts: number of open contracts at the start of the trading day.
     """
-    df_raw = cm.fetch_past_raw_df(asset_code="DDI", trade_date=trade_date)
+    df_raw = cm.fetch_raw_df(asset_code="DDI", trade_date=trade_date)
     if return_raw or df_raw.empty:
         return df_raw
-    return _process_raw_df(df_raw, trade_date)
+    df = cm.process_raw_df(df_raw, trade_date, asset_code="DDI")
+    df = _process_ddi_df(df, trade_date)
+    return cm.reorder_columns(df)

{pyield-0.7.7/pyield/futures → pyield-0.7.8/pyield/futures/historical}/di.py

@@ -1,6 +1,6 @@
 import pandas as pd
 
-from .. import bday as bd
+from ... import bday as bd
 from . import common as cm
 
 
@@ -31,7 +31,7 @@ def _adjust_older_contracts_rates(df: pd.DataFrame, rate_cols: list) -> pd.DataF
     return df
 
 
-def _process_past_raw_df(df: pd.DataFrame, trade_date: pd.Timestamp) -> pd.DataFrame:
+def _process_df(df: pd.DataFrame, trade_date: pd.Timestamp) -> pd.DataFrame:
     """
     Internal function to process and transform raw DI futures data.
 
@@ -42,31 +42,12 @@ def _process_past_raw_df(df: pd.DataFrame, trade_date: pd.Timestamp) -> pd.DataF
     Returns:
         pd.DataFrame: Processed and transformed data as a Pandas pd.DataFrame.
     """
-    df = cm.rename_columns(df)
-
-    df["TradeDate"] = trade_date
-    # Convert to datetime64[ns] since it is pandas default type for timestamps
-    df["TradeDate"] = df["TradeDate"].astype("datetime64[ns]")
-
-    # Contract code format was changed in 22/05/2006
-    if trade_date < pd.Timestamp("2006-05-22"):
-        df["ExpirationDate"] = df["ExpirationCode"].apply(
-            cm.get_old_expiration_date, args=(trade_date,)
-        )
-    else:
-        df["ExpirationDate"] = df["ExpirationCode"].apply(cm.get_expiration_date)
-
     df["BDaysToExp"] = bd.count_bdays(trade_date, df["ExpirationDate"])
 
     # Remove expired contracts
     df.query("BDaysToExp > 0", inplace=True)
 
-    # Columns where 0 means NaN
     rate_cols = [col for col in df.columns if "Rate" in col]
-    cols_with_nan = rate_cols + ["SettlementPrice"]
-    # Replace 0 with NaN in these columns
-    df[cols_with_nan] = df[cols_with_nan].replace(0, pd.NA)
-
     # Prior to 17/01/2002 (inclusive), prices were not converted to rates
     if trade_date > pd.Timestamp("2002-01-17"):
         # Remove % and round to 5 (3 in %) dec. places in rate columns
@@ -79,62 +60,10 @@ def _process_past_raw_df(df: pd.DataFrame, trade_date: pd.Timestamp) -> pd.DataF
         df["SettlementPrice"], df["BDaysToExp"]
     )
 
-    df["TickerSymbol"] = "DI1" + df["ExpirationCode"]
-
-    # Filter and order columns
-    df = cm.reorder_columns(df)
     return df
 
 
-def _process_last_raw_di_df(raw_df: pd.DataFrame) -> pd.DataFrame:
-    df = raw_df.copy()
-
-    # Columns to be renamed
-    rename_columns = {
-        "TradeTimestamp": "TradeTimestamp",
-        "symb": "TickerSymbol",
-        "mtrtyCode": "ExpirationDate",
-        "BDaysToExp": "BDaysToExp",
-        "opnCtrcts": "OpenContracts",
-        "tradQty": "TradeCount",
-        "traddCtrctsQty": "TradeVolume",
-        "grssAmt": "FinancialVolume",
-        "prvsDayAdjstmntPric": "PrevSettlementRate",
-        "bottomLmtPric": "MinLimitRate",
-        "topLmtPric": "MaxLimitRate",
-        "opngPric": "OpenRate",
-        "minPric": "MinRate",
-        "avrgPric": "AvgRate",
-        "maxPric": "MaxRate",
-        "buyOffer.price": "LastAskRate",
-        "sellOffer.price": "LastBidRate",
-        "curPrc": "LastRate",
-    }
-    # Rename columns
-    df = df.rename(columns=rename_columns)
-
-    df["BDaysToExp"] = bd.count_bdays(df["TradeTimestamp"], df["ExpirationDate"])
-
-    # Remove percentage in all rate columns
-    rate_cols = [col for col in df.columns if "Rate" in col]
-    df[rate_cols] = df[rate_cols] / 100
-
-    # Reorder columns based on the order of the dictionary
-    return df[rename_columns.values()]
-
-
-def fetch_last_di() -> pd.DataFrame:
-    """
-    Fetch the latest DI futures data from B3.
-
-    Returns:
-        pd.DataFrame: A Pandas pd.DataFrame containing the latest DI futures data.
-    """
-    raw_df = cm.fetch_last_raw_df(future_code="DI1")
-    return _process_last_raw_di_df(raw_df)
-
-
-def fetch_past_di(trade_date: pd.Timestamp, return_raw: bool = False) -> pd.DataFrame:
+def fetch_di(trade_date: pd.Timestamp, return_raw: bool = False) -> pd.DataFrame:
     """
     Fetchs the DI futures data for a given date from B3.
 
@@ -154,7 +83,9 @@ def fetch_past_di(trade_date: pd.Timestamp, return_raw: bool = False) -> pd.Data
         - BDaysToExp: number of business days to ExpirationDate.
         - OpenContracts: number of open contracts at the start of the trading day.
     """
-    df_raw = cm.fetch_past_raw_df(asset_code="DI1", trade_date=trade_date)
+    df_raw = cm.fetch_raw_df(asset_code="DI1", trade_date=trade_date)
     if return_raw or df_raw.empty:
         return df_raw
-    return _process_past_raw_df(df_raw, trade_date)
+    df = cm.process_raw_df(df_raw, trade_date, asset_code="DI1")
+    df = _process_df(df, trade_date)
+    return cm.reorder_columns(df)

{pyield-0.7.7/pyield/futures → pyield-0.7.8/pyield/futures/historical}/di_xml.py

@@ -7,7 +7,7 @@ import requests
 from lxml import etree
 from pandas import DataFrame, Timestamp
 
-from .. import bday
+from ... import bday
 from . import common as cm
 
 
@@ -206,7 +206,7 @@ def _standardize_column_names(df: DataFrame) -> DataFrame:
         "TradAvrgPric": "AvgRate",
         "MaxPric": "MaxRate",
         "FrstPric": "FirstRate",
-        "LastPric": "LastRate",
+        "LastPric": "CloseRate",
         "AdjstdQtTax": "SettlementRate",
         # "RglrTxsQty"
         # "RglrTraddCtrcts"

{pyield-0.7.7/pyield/futures → pyield-0.7.8/pyield/futures/historical}/frc.py

@@ -3,7 +3,7 @@ import pandas as pd
 from . import common as cm
 
 
-def _process_past_data(df: pd.DataFrame, trade_date: pd.Timestamp) -> pd.DataFrame:
+def _process_frc_df(df: pd.DataFrame, trade_date: pd.Timestamp) -> pd.DataFrame:
     """
     Internal function to process and transform raw DI futures data.
 
@@ -33,14 +33,10 @@ def _process_past_data(df: pd.DataFrame, trade_date: pd.Timestamp) -> pd.DataFra
     # Round to 5 decimal places (3 in %) since it is the contract's precision
     df[rate_cols] = df[rate_cols].replace(0, pd.NA).div(100).round(5)
 
-    df["TickerSymbol"] = "FRC" + df["ExpirationCode"]
-
-    # Filter and order columns
-    df = cm.reorder_columns(df)
     return df
 
 
-def fetch_past_frc(trade_date: pd.Timestamp, return_raw: bool = False) -> pd.DataFrame:
+def fetch_frc(trade_date: pd.Timestamp, return_raw: bool = False) -> pd.DataFrame:
     """
     Fetchs the DI futures data for a given date from B3.
 
@@ -55,7 +51,10 @@ def fetch_past_frc(trade_date: pd.Timestamp, return_raw: bool = False) -> pd.Dat
     Returns:
         pd.DataFrame: A Pandas pd.DataFrame containing processed DI futures data.
     """
-    df_raw = cm.fetch_past_raw_df(asset_code="FRC", trade_date=trade_date)
+    df_raw = cm.fetch_raw_df(asset_code="FRC", trade_date=trade_date)
     if return_raw or df_raw.empty:
         return df_raw
-    return _process_past_data(df_raw, trade_date)
+    # Filter and order columns
+    df = cm.process_raw_df(df_raw, trade_date, asset_code="FRC")
+    df = _process_frc_df(df, trade_date)
+    return cm.reorder_columns(df)

pyield-0.7.8/pyield/futures/intraday/__init__.py

@@ -0,0 +1,3 @@
+from .trading_data import fetch_intraday
+
+__all__ = ["fetch_intraday"]

pyield-0.7.8/pyield/futures/intraday/trading_data.py

@@ -0,0 +1,107 @@
+import pandas as pd
+import requests
+
+
+def _fetch_raw_df(future_code: str) -> pd.DataFrame:
+    """
+    Fetch the latest data for a given future code from B3 derivatives quotation API.
+
+    Args:
+    future_code (str): The future code to fetch data for.
+
+    Returns:
+    pd.DataFrame: A DataFrame containing the normalized and cleaned data from the API.
+
+    Raises:
+    Exception: An exception is raised if the data fetch operation fails.
+    """
+
+    url = f"https://cotacao.b3.com.br/mds/api/v1/DerivativeQuotation/{future_code}"
+
+    try:
+        r = requests.get(url)
+        r.raise_for_status()  # Check for HTTP request errors
+    except requests.exceptions.RequestException:
+        raise Exception(f"Failed to fetch data for {future_code}.") from None
+
+    r.encoding = "utf-8"  # Explicitly set response encoding to utf-8 for consistency
+
+    if "Quotation not available" in r.text:
+        return pd.DataFrame()
+
+    # Normalize JSON response into a flat table
+    df = pd.json_normalize(r.json()["Scty"])
+
+    # Clean and reformat the DataFrame columns
+    df.columns = (df.columns
+        .str.replace("SctyQtn.", "")
+        .str.replace("asset.AsstSummry.", "")
+    )  # fmt: skip
+    df.drop(columns=["desc", "asset.code", "mkt.cd"], inplace=True)
+
+    # Convert maturity codes to datetime and drop rows with missing values
+    df["mtrtyCode"] = pd.to_datetime(df["mtrtyCode"], errors="coerce")
+    df.dropna(subset=["mtrtyCode"], inplace=True)
+
+    # Sort the DataFrame by maturity code and reset the index
+    df.sort_values("mtrtyCode", inplace=True, ignore_index=True)
+
+    # Get current date and time
+    now = pd.Timestamp.now().round("s")
+    # Subtract 15 minutes from the current time to account for API delay
+    trade_ts = now - pd.Timedelta(minutes=15)
+    df["TradeTimestamp"] = trade_ts
+
+    # Convert DataFrame to use nullable data types for better type consistency
+    df = df.convert_dtypes(dtype_backend="numpy_nullable")
+
+    return df
+
+
+def _process_raw_df(raw_df: pd.DataFrame) -> pd.DataFrame:
+    df = raw_df.copy()
+
+    # Columns to be renamed
+    all_columns = {
+        "TradeTimestamp": "TradeTimestamp",
+        "symb": "TickerSymbol",
+        "mtrtyCode": "ExpirationDate",
+        "BDaysToExp": "BDaysToExp",
+        "opnCtrcts": "OpenContracts",
+        "tradQty": "TradeCount",
+        "traddCtrctsQty": "TradeVolume",
+        "grssAmt": "FinancialVolume",
+        "prvsDayAdjstmntPric": "PrevSettlementRate",
+        "bottomLmtPric": "MinLimitRate",
+        "topLmtPric": "MaxLimitRate",
+        "opngPric": "OpenRate",
+        "minPric": "MinRate",
+        "avrgPric": "AvgRate",
+        "maxPric": "MaxRate",
+        "buyOffer.price": "CurrentAskRate",
+        "sellOffer.price": "CurrentBidRate",
+        "curPrc": "CurrentRate",
+    }
+    # Check which columns are present in the DataFrame before renaming
+    rename_dict = {c: all_columns[c] for c in all_columns if c in df.columns}
+    df = df.rename(columns=rename_dict)
+
+    # df["BDaysToExp"] = bd.count_bdays(df["TradeTimestamp"], df["ExpirationDate"])
+
+    # Remove percentage in all rate columns
+    rate_cols = [col for col in df.columns if "Rate" in col]
+    df[rate_cols] = df[rate_cols] / 100
+
+    # Reorder columns based on the order of the dictionary
+    return df[rename_dict.values()]
+
+
+def fetch_intraday(future_code: str) -> pd.DataFrame:
+    """
+    Fetch the latest DI futures data from B3.
+
+    Returns:
+        pd.DataFrame: A Pandas pd.DataFrame containing the latest DI futures data.
+    """
+    raw_df = _fetch_raw_df(future_code)
+    return _process_raw_df(raw_df)

{pyield-0.7.7 → pyield-0.7.8}/pyield/treasuries.py

@@ -3,7 +3,7 @@ import io
 import pandas as pd
 import requests
 
-from . import futures as ft
+from .futures import historical as fh
 
 # URL Constants
 ANBIMA_NON_MEMBER_URL = "https://www.anbima.com.br/informacoes/merc-sec/arqs/"
@@ -150,7 +150,7 @@ def calculate_di_spreads(reference_date: pd.Timestamp) -> pd.DataFrame:
             bond type and maturity date.
     """
     # Fetch DI rates and adjust the maturity date format for compatibility
-    df_di = ft.fetch_past_di(reference_date)[["ExpirationDate", "SettlementRate"]]
+    df_di = fh.fetch_di(reference_date)[["ExpirationDate", "SettlementRate"]]
 
     # Renaming the columns to match the ANBIMA structure
     df_di.rename(columns={"ExpirationDate": "MaturityDate"}, inplace=True)

{pyield-0.7.7 → pyield-0.7.8}/pyproject.toml

@@ -23,16 +23,16 @@ classifiers = [
     "Topic :: Office/Business :: Financial :: Investment",
 ]
 dependencies = [
-    "requests",
     "pandas>=2.0.0",
     "numpy",
     "beautifulsoup4",
     "html5lib",
     "lxml",
     "python-calamine>=0.2.0",
+    "requests>=2.31.0",
 ]
 dynamic = []
-version = "0.7.7"
+version = "0.7.8"
 
 [project.license]
 file = "LICENSE"

pyield-0.7.8/tests/test_futures.py

@@ -0,0 +1,38 @@
+import pyield as yd
+
+
+def test_settlement_rate_with_old_holiday_list():
+    settlement_rates = {
+        "DI1N27": 0.09809,
+        "DI1F33": 0.10368,
+    }
+
+    # 22-12-2023 is before the new holiday calendar
+    df = yd.fetch_asset(asset_code="DI1", reference_date="2023-12-22")
+    tickers = list(settlement_rates.keys())  # noqa: F841
+    result = df.query("TickerSymbol in @tickers")["SettlementRate"].to_list()
+    assert result == list(settlement_rates.values())
+
+
+def test_settlement_rates_with_current_holiday_list():
+    settlement_rates = {
+        "DI1F24": 0.11644,
+        "DI1J24": 0.11300,
+        "DI1N24": 0.10786,
+        "DI1V24": 0.10321,
+        "DI1F25": 0.10031,
+        "DI1J25": 0.09852,
+        "DI1N25": 0.09715,
+        "DI1V25": 0.09651,
+        "DI1F26": 0.09583,
+        "DI1N26": 0.09631,
+        "DI1F27": 0.09683,
+        "DI1N27": 0.09794,
+        "DI1F29": 0.10042,
+        "DI1F31": 0.10240,
+        "DI1F33": 0.10331,
+    }
+    df = yd.fetch_asset(asset_code="DI1", reference_date="2023-12-26")
+    tickers = list(settlement_rates.keys())  # noqa: F841
+    results = df.query("TickerSymbol in @tickers")["SettlementRate"].to_list()
+    assert results == list(settlement_rates.values())

pyield-0.7.7/pyield/__about__.py

@@ -1 +0,0 @@
-__version__ = "0.7.7"

pyield-0.7.7/pyield/futures/__init__.py

@@ -1,13 +0,0 @@
-from .common import get_expiration_date, get_old_expiration_date
-from .ddi import fetch_past_ddi
-from .di import fetch_last_di, fetch_past_di
-from .frc import fetch_past_frc
-
-__all__ = [
-    "fetch_past_di",
-    "fetch_last_di",
-    "fetch_past_ddi",
-    "fetch_past_frc",
-    "get_expiration_date",
-    "get_old_expiration_date",
-]

pyield-0.7.7/tests/test_futures.py

@@ -1,80 +0,0 @@
-import pandas as pd
-
-from pyield import futures as ft
-
-
-def test_valid_old_contract_code1():
-    expiration_code = "JAN3"  # Valid contract code
-    trade_date = pd.Timestamp("2001-05-21")
-    result = ft.get_old_expiration_date(expiration_code, trade_date)
-    contract_expiration = pd.Timestamp("2003-01-02")
-    assert result == contract_expiration
-
-
-def test_valid_old_contract_code2():
-    expiration_code = "JAN3"  # Valid contract code
-    trade_date = pd.Timestamp("1990-01-01")
-    result = ft.get_old_expiration_date(expiration_code, trade_date)
-    contract_expiration = pd.Timestamp("1993-01-04")
-    assert result == contract_expiration
-
-
-def test_invalid_old_contract_code():
-    expiration_code = "J3"  # Invalid contract code
-    trade_date = pd.Timestamp("2001-01-02")
-    # Must return NaT
-    result = ft.get_old_expiration_date(expiration_code, trade_date)
-    assert pd.isnull(result)
-
-
-def test_new_contract_code():
-    expiration_code = "F23"  # Valid contract code
-    result = ft.get_expiration_date(expiration_code)
-    contract_expiration = pd.Timestamp("2023-01-02")
-    assert result == contract_expiration
-
-
-def test_settlement_rate_with_old_holiday_list():
-    settlement_rates = {
-        "DI1N27": 0.09809,
-        "DI1F33": 0.10368,
-    }
-
-    # 22-12-2023 is before the new holiday calendar
-    test_date = pd.Timestamp("2023-12-22")
-    df = ft.fetch_past_di(trade_date=test_date)
-    tickers = list(settlement_rates.keys())  # noqa: F841
-    result = df.query("TickerSymbol in @tickers")["SettlementRate"].to_list()
-    assert result == list(settlement_rates.values())
-
-
-def test_settlement_rates_with_current_holiday_list():
-    settlement_rates = {
-        "DI1F24": 0.11644,
-        "DI1J24": 0.11300,
-        "DI1N24": 0.10786,
-        "DI1V24": 0.10321,
-        "DI1F25": 0.10031,
-        "DI1J25": 0.09852,
-        "DI1N25": 0.09715,
-        "DI1V25": 0.09651,
-        "DI1F26": 0.09583,
-        "DI1N26": 0.09631,
-        "DI1F27": 0.09683,
-        "DI1N27": 0.09794,
-        "DI1F29": 0.10042,
-        "DI1F31": 0.10240,
-        "DI1F33": 0.10331,
-    }
-    test_date = pd.Timestamp("2023-12-26")
-    df = ft.fetch_past_di(trade_date=test_date)
-    tickers = list(settlement_rates.keys())  # noqa: F841
-    results = df.query("TickerSymbol in @tickers")["SettlementRate"].to_list()
-    assert results == list(settlement_rates.values())
-
-
-def test_non_business_day():
-    non_business_day = pd.Timestamp("2023-12-24")
-    # Test if it an empty DataFrame is returned
-    df = ft.fetch_past_di(trade_date=non_business_day)
-    assert df.empty