UtmEndpoint

cl_forge.cmf.UtmEndpoint dataclass

UtmEndpoint(api_key: str)

Bases: CmfEndpoint[UtmRecord]

Client for the CMF UTM (Unidad Tributaria Mensual) endpoints.

Parameters:

Name	Type	Description	Default
api_key	str	CMF API key.	required

Source code in src/cl_forge/core/endpoints.py

def __init__(self, api_key: str) -> None:
    """
    Initialize the UTM endpoint client.

    Parameters
    ----------
    api_key : str
        CMF API key.
    """
    super().__init__(api_key, "/utm", UtmRecord, "UTMs")

current

current() -> UtmRecord

Get the latest available UTM value.

Returns:

Type	Description
UtmRecord	The latest UTM record.

Source code in src/cl_forge/core/endpoints.py

def current(self) -> UtmRecord:
    """
    Get the latest available UTM value.

    Returns
    -------
    UtmRecord
        The latest UTM record.
    """
    return super().current()

year

year(year: int | None = None) -> list[UtmRecord]

Get the UTM values for a given year.

Parameters:

Name	Type	Description	Default
year	int | None	The year for which to retrieve UTM values. If None, defaults to the current year.	None

Returns:

Type	Description
list[UtmRecord]	A list of UTM records for the specified year.

Source code in src/cl_forge/core/endpoints.py

def year(self, year: int | None = None) -> list[UtmRecord]:
    """
    Get the UTM values for a given year.

    Parameters
    ----------
    year : int | None
        The year for which to retrieve UTM values. If None, defaults to the
        current year.

    Returns
    -------
    list[UtmRecord]
        A list of UTM records for the specified year.
    """
    return super().year(year)