Skip to content

UfEndpoint

cl_forge.cmf.UfEndpoint dataclass 

UfEndpoint(api_key: str)

Bases: CmfEndpoint[UfRecord]

Client for the CMF UF (Unidad de Fomento) endpoints.

Parameters:

Name Type Description Default
api_key str

CMF API key.

 required
Source code in src/cl_forge/core/endpoints.py 
245
246
247
248
249
250
251
252
253
254
def __init__(self, api_key: str) -> None:
    """
    Initialize the UF endpoint client.

    Parameters
    ----------
    api_key : str
        CMF API key.
    """
    super().__init__(api_key, "/uf", UfRecord, "UFs")

current 

current() -> UfRecord

Get the latest available UF value.

Returns:

Type Description
UfRecord

The latest UF record.
Source code in src/cl_forge/core/endpoints.py 
256
257
258
259
260
261
262
263
264
265
def current(self) -> UfRecord:
    """
    Get the latest available UF value.

    Returns
    -------
    UfRecord
        The latest UF record.
    """
    return super().current()

year 

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

Get the UF values for a given year.

Parameters:

Name Type Description Default
year int | None

The year for which to retrieve UF values. If None, defaults to the current year.

 None

Returns:

Type Description
list[UfRecord]

A list of UF records for the specified year.
Source code in src/cl_forge/core/endpoints.py 
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
def year(self, year: int | None = None) -> list[UfRecord]:
    """
    Get the UF values for a given year.

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

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