balancing-services 2.1.0__tar.gz → 2.2.0__tar.gz

{balancing_services-2.1.0 → balancing_services-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: balancing-services
-Version: 2.1.0
+Version: 2.2.0
 Summary: Official Python client for accessing European electricity balancing market data via the Balancing Services REST API
 Project-URL: Homepage, https://balancing.services
 Project-URL: Documentation, https://api.balancing.services/v2/documentation

balancing_services-2.2.0/balancing_services/api/default/get_imbalance_price_history.py

@@ -0,0 +1,307 @@
+import datetime
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.area import Area
+from ...models.imbalance_price_history_response import ImbalancePriceHistoryResponse
+from ...models.problem import Problem
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    area: Area,
+    period_start_at: datetime.datetime,
+    period_end_at: datetime.datetime,
+    cursor: str | Unset = UNSET,
+    limit: int | Unset = 100,
+    updated_since: datetime.datetime | Unset = UNSET,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    json_area: str = area
+    params["area"] = json_area
+
+    json_period_start_at = period_start_at.isoformat()
+    params["period-start-at"] = json_period_start_at
+
+    json_period_end_at = period_end_at.isoformat()
+    params["period-end-at"] = json_period_end_at
+
+    params["cursor"] = cursor
+
+    params["limit"] = limit
+
+    json_updated_since: str | Unset = UNSET
+    if not isinstance(updated_since, Unset):
+        json_updated_since = updated_since.isoformat()
+    params["updated-since"] = json_updated_since
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/imbalance/prices/history",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ImbalancePriceHistoryResponse | Problem | None:
+    if response.status_code == 200:
+        response_200 = ImbalancePriceHistoryResponse.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 400:
+        response_400 = Problem.from_dict(response.json())
+
+        return response_400
+
+    if response.status_code == 401:
+        response_401 = Problem.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 403:
+        response_403 = Problem.from_dict(response.json())
+
+        return response_403
+
+    if response.status_code == 404:
+        response_404 = Problem.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 429:
+        response_429 = Problem.from_dict(response.json())
+
+        return response_429
+
+    if response.status_code == 500:
+        response_500 = Problem.from_dict(response.json())
+
+        return response_500
+
+    if response.status_code == 501:
+        response_501 = Problem.from_dict(response.json())
+
+        return response_501
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[ImbalancePriceHistoryResponse | Problem]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    area: Area,
+    period_start_at: datetime.datetime,
+    period_end_at: datetime.datetime,
+    cursor: str | Unset = UNSET,
+    limit: int | Unset = 100,
+    updated_since: datetime.datetime | Unset = UNSET,
+) -> Response[ImbalancePriceHistoryResponse | Problem]:
+    """Get the revision history of the imbalance prices for an area
+
+     **Experimental** - This endpoint is under active development and may change without notice.
+
+    Returns how the imbalance prices on `/imbalance/prices` reached their current values: the
+    sequence of values held for a period, each stamped with the `observedAt` it was recorded at.
+    The response is the `/imbalance/prices` shape with `observedAt` added to each entry of
+    `prices`, which carries the revision entries, ascending by `observedAt`.
+
+    Args:
+        area (Area): Area code
+        period_start_at (datetime.datetime):  Example: 2025-01-01T00:00:00Z.
+        period_end_at (datetime.datetime):  Example: 2025-01-02T00:00:00Z.
+        cursor (str | Unset):  Example: v1:AAAAAYwBAgMEBQYHCAkKCw==.
+        limit (int | Unset):  Default: 100. Example: 100.
+        updated_since (datetime.datetime | Unset):  Example: 2025-01-02T09:15:00Z.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[ImbalancePriceHistoryResponse | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        area=area,
+        period_start_at=period_start_at,
+        period_end_at=period_end_at,
+        cursor=cursor,
+        limit=limit,
+        updated_since=updated_since,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    area: Area,
+    period_start_at: datetime.datetime,
+    period_end_at: datetime.datetime,
+    cursor: str | Unset = UNSET,
+    limit: int | Unset = 100,
+    updated_since: datetime.datetime | Unset = UNSET,
+) -> ImbalancePriceHistoryResponse | Problem | None:
+    """Get the revision history of the imbalance prices for an area
+
+     **Experimental** - This endpoint is under active development and may change without notice.
+
+    Returns how the imbalance prices on `/imbalance/prices` reached their current values: the
+    sequence of values held for a period, each stamped with the `observedAt` it was recorded at.
+    The response is the `/imbalance/prices` shape with `observedAt` added to each entry of
+    `prices`, which carries the revision entries, ascending by `observedAt`.
+
+    Args:
+        area (Area): Area code
+        period_start_at (datetime.datetime):  Example: 2025-01-01T00:00:00Z.
+        period_end_at (datetime.datetime):  Example: 2025-01-02T00:00:00Z.
+        cursor (str | Unset):  Example: v1:AAAAAYwBAgMEBQYHCAkKCw==.
+        limit (int | Unset):  Default: 100. Example: 100.
+        updated_since (datetime.datetime | Unset):  Example: 2025-01-02T09:15:00Z.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        ImbalancePriceHistoryResponse | Problem
+    """
+
+    return sync_detailed(
+        client=client,
+        area=area,
+        period_start_at=period_start_at,
+        period_end_at=period_end_at,
+        cursor=cursor,
+        limit=limit,
+        updated_since=updated_since,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    area: Area,
+    period_start_at: datetime.datetime,
+    period_end_at: datetime.datetime,
+    cursor: str | Unset = UNSET,
+    limit: int | Unset = 100,
+    updated_since: datetime.datetime | Unset = UNSET,
+) -> Response[ImbalancePriceHistoryResponse | Problem]:
+    """Get the revision history of the imbalance prices for an area
+
+     **Experimental** - This endpoint is under active development and may change without notice.
+
+    Returns how the imbalance prices on `/imbalance/prices` reached their current values: the
+    sequence of values held for a period, each stamped with the `observedAt` it was recorded at.
+    The response is the `/imbalance/prices` shape with `observedAt` added to each entry of
+    `prices`, which carries the revision entries, ascending by `observedAt`.
+
+    Args:
+        area (Area): Area code
+        period_start_at (datetime.datetime):  Example: 2025-01-01T00:00:00Z.
+        period_end_at (datetime.datetime):  Example: 2025-01-02T00:00:00Z.
+        cursor (str | Unset):  Example: v1:AAAAAYwBAgMEBQYHCAkKCw==.
+        limit (int | Unset):  Default: 100. Example: 100.
+        updated_since (datetime.datetime | Unset):  Example: 2025-01-02T09:15:00Z.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[ImbalancePriceHistoryResponse | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        area=area,
+        period_start_at=period_start_at,
+        period_end_at=period_end_at,
+        cursor=cursor,
+        limit=limit,
+        updated_since=updated_since,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    area: Area,
+    period_start_at: datetime.datetime,
+    period_end_at: datetime.datetime,
+    cursor: str | Unset = UNSET,
+    limit: int | Unset = 100,
+    updated_since: datetime.datetime | Unset = UNSET,
+) -> ImbalancePriceHistoryResponse | Problem | None:
+    """Get the revision history of the imbalance prices for an area
+
+     **Experimental** - This endpoint is under active development and may change without notice.
+
+    Returns how the imbalance prices on `/imbalance/prices` reached their current values: the
+    sequence of values held for a period, each stamped with the `observedAt` it was recorded at.
+    The response is the `/imbalance/prices` shape with `observedAt` added to each entry of
+    `prices`, which carries the revision entries, ascending by `observedAt`.
+
+    Args:
+        area (Area): Area code
+        period_start_at (datetime.datetime):  Example: 2025-01-01T00:00:00Z.
+        period_end_at (datetime.datetime):  Example: 2025-01-02T00:00:00Z.
+        cursor (str | Unset):  Example: v1:AAAAAYwBAgMEBQYHCAkKCw==.
+        limit (int | Unset):  Default: 100. Example: 100.
+        updated_since (datetime.datetime | Unset):  Example: 2025-01-02T09:15:00Z.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        ImbalancePriceHistoryResponse | Problem
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            area=area,
+            period_start_at=period_start_at,
+            period_end_at=period_end_at,
+            cursor=cursor,
+            limit=limit,
+            updated_since=updated_since,
+        )
+    ).parsed

{balancing_services-2.1.0 → balancing_services-2.2.0}/balancing_services/models/__init__.py

@@ -53,6 +53,9 @@ from .imbalance_price_forecast import ImbalancePriceForecast
 from .imbalance_price_forecast_quantile import ImbalancePriceForecastQuantile
 from .imbalance_price_forecasts import ImbalancePriceForecasts
 from .imbalance_price_forecasts_response import ImbalancePriceForecastsResponse
+from .imbalance_price_history import ImbalancePriceHistory
+from .imbalance_price_history_response import ImbalancePriceHistoryResponse
+from .imbalance_price_revision import ImbalancePriceRevision
 from .imbalance_prices import ImbalancePrices
 from .imbalance_prices_response import ImbalancePricesResponse
 from .imbalance_total_volumes import ImbalanceTotalVolumes
@@ -114,6 +117,9 @@ __all__ = (
     "ImbalancePriceForecastQuantile",
     "ImbalancePriceForecasts",
     "ImbalancePriceForecastsResponse",
+    "ImbalancePriceHistory",
+    "ImbalancePriceHistoryResponse",
+    "ImbalancePriceRevision",
     "ImbalancePrices",
     "ImbalancePricesResponse",
     "ImbalanceTotalVolumes",

balancing_services-2.2.0/balancing_services/models/imbalance_price_history.py

@@ -0,0 +1,112 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..models.area import Area, check_area
+from ..models.currency import Currency, check_currency
+from ..models.eic_code import EicCode, check_eic_code
+from ..models.imbalance_direction import ImbalanceDirection, check_imbalance_direction
+
+if TYPE_CHECKING:
+    from ..models.imbalance_price_revision import ImbalancePriceRevision
+
+
+T = TypeVar("T", bound="ImbalancePriceHistory")
+
+
+@_attrs_define
+class ImbalancePriceHistory:
+    """
+    Attributes:
+        area (Area): Area code
+        eic_code (EicCode): Energy Identification Code (EIC)
+        currency (Currency): Currency code
+        direction (ImbalanceDirection): Imbalance direction
+        prices (list[ImbalancePriceRevision]):
+    """
+
+    area: Area
+    eic_code: EicCode
+    currency: Currency
+    direction: ImbalanceDirection
+    prices: list[ImbalancePriceRevision]
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        area: str = self.area
+
+        eic_code: str = self.eic_code
+
+        currency: str = self.currency
+
+        direction: str = self.direction
+
+        prices = []
+        for prices_item_data in self.prices:
+            prices_item = prices_item_data.to_dict()
+            prices.append(prices_item)
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "area": area,
+                "eicCode": eic_code,
+                "currency": currency,
+                "direction": direction,
+                "prices": prices,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.imbalance_price_revision import ImbalancePriceRevision
+
+        d = dict(src_dict)
+        area = check_area(d.pop("area"))
+
+        eic_code = check_eic_code(d.pop("eicCode"))
+
+        currency = check_currency(d.pop("currency"))
+
+        direction = check_imbalance_direction(d.pop("direction"))
+
+        prices = []
+        _prices = d.pop("prices")
+        for prices_item_data in _prices:
+            prices_item = ImbalancePriceRevision.from_dict(prices_item_data)
+
+            prices.append(prices_item)
+
+        imbalance_price_history = cls(
+            area=area,
+            eic_code=eic_code,
+            currency=currency,
+            direction=direction,
+            prices=prices,
+        )
+
+        imbalance_price_history.additional_properties = d
+        return imbalance_price_history
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

balancing_services-2.2.0/balancing_services/models/imbalance_price_history_response.py

@@ -0,0 +1,128 @@
+from __future__ import annotations
+
+import datetime
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar, cast
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+if TYPE_CHECKING:
+    from ..models.imbalance_price_history import ImbalancePriceHistory
+    from ..models.period import Period
+
+
+T = TypeVar("T", bound="ImbalancePriceHistoryResponse")
+
+
+@_attrs_define
+class ImbalancePriceHistoryResponse:
+    """
+    Attributes:
+        queried_period (Period):
+        data (list[ImbalancePriceHistory]):
+        has_more (bool): Indicates whether there are more results available
+        next_updated_since (datetime.datetime): The watermark to pass as `updated-since` on the next poll. Every page of
+            one drain reports the same value. It deliberately lags real time to cover writes that were still committing, so
+            consecutive polls overlap slightly and a record may be delivered more than once — upsert on consume. Example:
+            2025-01-02T09:15:00Z.
+        next_cursor (None | str | Unset): Cursor to fetch the next page of results. Null if no more results. Example:
+            v1:AAAAAYwBAgMEBQYHCAkKCw==.
+    """
+
+    queried_period: Period
+    data: list[ImbalancePriceHistory]
+    has_more: bool
+    next_updated_since: datetime.datetime
+    next_cursor: None | str | Unset = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        queried_period = self.queried_period.to_dict()
+
+        data = []
+        for data_item_data in self.data:
+            data_item = data_item_data.to_dict()
+            data.append(data_item)
+
+        has_more = self.has_more
+
+        next_updated_since = self.next_updated_since.isoformat()
+
+        next_cursor: None | str | Unset
+        if isinstance(self.next_cursor, Unset):
+            next_cursor = UNSET
+        else:
+            next_cursor = self.next_cursor
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "queriedPeriod": queried_period,
+                "data": data,
+                "hasMore": has_more,
+                "nextUpdatedSince": next_updated_since,
+            }
+        )
+        if next_cursor is not UNSET:
+            field_dict["nextCursor"] = next_cursor
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.imbalance_price_history import ImbalancePriceHistory
+        from ..models.period import Period
+
+        d = dict(src_dict)
+        queried_period = Period.from_dict(d.pop("queriedPeriod"))
+
+        data = []
+        _data = d.pop("data")
+        for data_item_data in _data:
+            data_item = ImbalancePriceHistory.from_dict(data_item_data)
+
+            data.append(data_item)
+
+        has_more = d.pop("hasMore")
+
+        next_updated_since = datetime.datetime.fromisoformat(d.pop("nextUpdatedSince").replace("Z", "+00:00"))
+
+        def _parse_next_cursor(data: object) -> None | str | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(None | str | Unset, data)
+
+        next_cursor = _parse_next_cursor(d.pop("nextCursor", UNSET))
+
+        imbalance_price_history_response = cls(
+            queried_period=queried_period,
+            data=data,
+            has_more=has_more,
+            next_updated_since=next_updated_since,
+            next_cursor=next_cursor,
+        )
+
+        imbalance_price_history_response.additional_properties = d
+        return imbalance_price_history_response
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

balancing_services-2.2.0/balancing_services/models/imbalance_price_revision.py

@@ -0,0 +1,84 @@
+from __future__ import annotations
+
+import datetime
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+if TYPE_CHECKING:
+    from ..models.period import Period
+
+
+T = TypeVar("T", bound="ImbalancePriceRevision")
+
+
+@_attrs_define
+class ImbalancePriceRevision:
+    """
+    Attributes:
+        period (Period):
+        price_per_mwh (float): Price per MWh in the specified currency Example: 45.5.
+        observed_at (datetime.datetime): When this revision was recorded (UTC) Example: 2026-08-04T10:07:31Z.
+    """
+
+    period: Period
+    price_per_mwh: float
+    observed_at: datetime.datetime
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        period = self.period.to_dict()
+
+        price_per_mwh = self.price_per_mwh
+
+        observed_at = self.observed_at.isoformat()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "period": period,
+                "pricePerMwh": price_per_mwh,
+                "observedAt": observed_at,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.period import Period
+
+        d = dict(src_dict)
+        period = Period.from_dict(d.pop("period"))
+
+        price_per_mwh = d.pop("pricePerMwh")
+
+        observed_at = datetime.datetime.fromisoformat(d.pop("observedAt").replace("Z", "+00:00"))
+
+        imbalance_price_revision = cls(
+            period=period,
+            price_per_mwh=price_per_mwh,
+            observed_at=observed_at,
+        )
+
+        imbalance_price_revision.additional_properties = d
+        return imbalance_price_revision
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

{balancing_services-2.1.0 → balancing_services-2.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "balancing-services"
-version = "2.1.0"
+version = "2.2.0"
 description = "Official Python client for accessing European electricity balancing market data via the Balancing Services REST API"
 readme = {file = "README.md", content-type = "text/markdown"}
 requires-python = ">=3.10"