Skip to content

UsdEndpoint

cl_forge.cmf.UsdEndpoint dataclass 

UsdEndpoint(api_key: str)

Bases: CmfEndpoint[UsdRecord]

Client for the CMF USD endpoints.

Parameters:

Name Type Description Default
api_key str

CMF API key.

 required
Source code in src/cl_forge/core/endpoints.py 
155
156
157
158
159
160
161
162
163
164
def __init__(self, api_key: str) -> None:
    """
    Initialize the USD endpoint client.

    Parameters
    ----------
    api_key : str
        CMF API key.
    """
    super().__init__(api_key, "/dolar", UsdRecord, "Dolares")

current 

current() -> UsdRecord

Get the latest available USD value.

Returns:

Type Description
UsdRecord

The latest USD record.
Source code in src/cl_forge/core/endpoints.py 
166
167
168
169
170
171
172
173
174
175
def current(self) -> UsdRecord:
    """
    Get the latest available USD value.

    Returns
    -------
    UsdRecord
        The latest USD record.
    """
    return super().current()

year 

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

Get the USD values for a given year.

Parameters:

Name Type Description Default
year int | None

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

 None

Returns:

Type Description
list[UsdRecord]

A list of USD records for the specified year.
Source code in src/cl_forge/core/endpoints.py 
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
def year(self, year: int | None = None) -> list[UsdRecord]:
    """
    Get the USD values for a given year.

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

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