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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: balancing-services
-Version: 2.2.0
+Version: 2.4.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
@@ -74,10 +74,7 @@ from balancing_services import AuthenticatedClient
 from balancing_services.api.default import get_imbalance_prices
 
 # Create an authenticated client
-client = AuthenticatedClient(
-    base_url="https://api.balancing.services/v2",
-    token="YOUR_API_TOKEN"
-)
+client = AuthenticatedClient(base_url="https://api.balancing.services/v2", token="YOUR_API_TOKEN")
 
 # Get imbalance prices for Estonia. Enum-typed parameters take plain string
 # values (e.g. area="EE") — see "Data Models" below.
@@ -85,7 +82,7 @@ response = get_imbalance_prices.sync_detailed(
     client=client,
     area="EE",
     period_start_at=datetime.fromisoformat("2025-01-01T00:00:00Z"),
-    period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z")
+    period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z"),
 )
 
 if response.status_code == 200:
@@ -108,10 +105,7 @@ Include your token when creating the client:
 ```python
 from balancing_services import AuthenticatedClient
 
-client = AuthenticatedClient(
-    base_url="https://api.balancing.services/v2",
-    token="YOUR_API_TOKEN"
-)
+client = AuthenticatedClient(base_url="https://api.balancing.services/v2", token="YOUR_API_TOKEN")
 ```
 
 ## Usage Examples
@@ -133,7 +127,7 @@ response = get_balancing_energy_bids.sync_detailed(
     period_start_at=datetime.fromisoformat("2025-01-01T00:00:00Z"),
     period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z"),
     reserve_type="aFRR",
-    limit=100
+    limit=100,
 )
 
 if response.status_code == 200:
@@ -155,7 +149,7 @@ if response.status_code == 200:
             period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z"),
             reserve_type="aFRR",
             cursor=data.next_cursor,
-            limit=100
+            limit=100,
         )
 ```
 
@@ -168,23 +162,22 @@ from datetime import datetime
 from balancing_services import AuthenticatedClient
 from balancing_services.api.default import get_imbalance_prices
 
+
 async def fetch_prices():
-    client = AuthenticatedClient(
-        base_url="https://api.balancing.services/v2",
-        token="YOUR_TOKEN"
-    )
+    client = AuthenticatedClient(base_url="https://api.balancing.services/v2", token="YOUR_TOKEN")
 
     response = await get_imbalance_prices.asyncio_detailed(
         client=client,
         area="EE",
         period_start_at=datetime.fromisoformat("2025-01-01T00:00:00Z"),
-        period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z")
+        period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z"),
     )
 
     if response.status_code == 200:
         return response.parsed
     return None
 
+
 # Run async function
 prices = asyncio.run(fetch_prices())
 ```
@@ -203,7 +196,7 @@ response = get_imbalance_prices.sync_detailed(
     client=client,
     area="EE",
     period_start_at=datetime.fromisoformat("2025-01-01T00:00:00Z"),
-    period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z")
+    period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z"),
 )
 
 if response.status_code == 200:
@@ -400,7 +393,7 @@ if response.status_code == 400:
 client = AuthenticatedClient(
     base_url="https://api.balancing.services/v2",
     token="YOUR_TOKEN",
-    timeout=30.0  # Increase from default
+    timeout=30.0,  # Increase from default
 )
 ```
 - Reduce the date range in your request
@@ -415,8 +408,8 @@ client = AuthenticatedClient(
 no enum member to import:
 ```python
 # Correct
-area="EE"
-reserve_type="aFRR"
+area = "EE"
+reserve_type = "aFRR"
 ```
 
 The accepted values for each enum are available as a `*_VALUES` set if you need

{balancing_services-2.2.0 → balancing_services-2.4.0}/README.md

@@ -38,10 +38,7 @@ from balancing_services import AuthenticatedClient
 from balancing_services.api.default import get_imbalance_prices
 
 # Create an authenticated client
-client = AuthenticatedClient(
-    base_url="https://api.balancing.services/v2",
-    token="YOUR_API_TOKEN"
-)
+client = AuthenticatedClient(base_url="https://api.balancing.services/v2", token="YOUR_API_TOKEN")
 
 # Get imbalance prices for Estonia. Enum-typed parameters take plain string
 # values (e.g. area="EE") — see "Data Models" below.
@@ -49,7 +46,7 @@ response = get_imbalance_prices.sync_detailed(
     client=client,
     area="EE",
     period_start_at=datetime.fromisoformat("2025-01-01T00:00:00Z"),
-    period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z")
+    period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z"),
 )
 
 if response.status_code == 200:
@@ -72,10 +69,7 @@ Include your token when creating the client:
 ```python
 from balancing_services import AuthenticatedClient
 
-client = AuthenticatedClient(
-    base_url="https://api.balancing.services/v2",
-    token="YOUR_API_TOKEN"
-)
+client = AuthenticatedClient(base_url="https://api.balancing.services/v2", token="YOUR_API_TOKEN")
 ```
 
 ## Usage Examples
@@ -97,7 +91,7 @@ response = get_balancing_energy_bids.sync_detailed(
     period_start_at=datetime.fromisoformat("2025-01-01T00:00:00Z"),
     period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z"),
     reserve_type="aFRR",
-    limit=100
+    limit=100,
 )
 
 if response.status_code == 200:
@@ -119,7 +113,7 @@ if response.status_code == 200:
             period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z"),
             reserve_type="aFRR",
             cursor=data.next_cursor,
-            limit=100
+            limit=100,
         )
 ```
 
@@ -132,23 +126,22 @@ from datetime import datetime
 from balancing_services import AuthenticatedClient
 from balancing_services.api.default import get_imbalance_prices
 
+
 async def fetch_prices():
-    client = AuthenticatedClient(
-        base_url="https://api.balancing.services/v2",
-        token="YOUR_TOKEN"
-    )
+    client = AuthenticatedClient(base_url="https://api.balancing.services/v2", token="YOUR_TOKEN")
 
     response = await get_imbalance_prices.asyncio_detailed(
         client=client,
         area="EE",
         period_start_at=datetime.fromisoformat("2025-01-01T00:00:00Z"),
-        period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z")
+        period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z"),
     )
 
     if response.status_code == 200:
         return response.parsed
     return None
 
+
 # Run async function
 prices = asyncio.run(fetch_prices())
 ```
@@ -167,7 +160,7 @@ response = get_imbalance_prices.sync_detailed(
     client=client,
     area="EE",
     period_start_at=datetime.fromisoformat("2025-01-01T00:00:00Z"),
-    period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z")
+    period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z"),
 )
 
 if response.status_code == 200:
@@ -364,7 +357,7 @@ if response.status_code == 400:
 client = AuthenticatedClient(
     base_url="https://api.balancing.services/v2",
     token="YOUR_TOKEN",
-    timeout=30.0  # Increase from default
+    timeout=30.0,  # Increase from default
 )
 ```
 - Reduce the date range in your request
@@ -379,8 +372,8 @@ client = AuthenticatedClient(
 no enum member to import:
 ```python
 # Correct
-area="EE"
-reserve_type="aFRR"
+area = "EE"
+reserve_type = "aFRR"
 ```
 
 The accepted values for each enum are available as a `*_VALUES` set if you need

balancing_services-2.4.0/balancing_services/api/default/get_balancing_energy_activated_volume_history.py

@@ -0,0 +1,332 @@
+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.balancing_energy_activated_volume_history_response import (
+    BalancingEnergyActivatedVolumeHistoryResponse,
+)
+from ...models.problem import Problem
+from ...models.reserve_type import ReserveType
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    area: Area,
+    period_start_at: datetime.datetime,
+    period_end_at: datetime.datetime,
+    reserve_type: ReserveType,
+    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
+
+    json_reserve_type: str = reserve_type
+    params["reserve-type"] = json_reserve_type
+
+    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": "/balancing/energy/activated-volumes/history",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> BalancingEnergyActivatedVolumeHistoryResponse | Problem | None:
+    if response.status_code == 200:
+        response_200 = BalancingEnergyActivatedVolumeHistoryResponse.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[BalancingEnergyActivatedVolumeHistoryResponse | 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,
+    reserve_type: ReserveType,
+    cursor: str | Unset = UNSET,
+    limit: int | Unset = 100,
+    updated_since: datetime.datetime | Unset = UNSET,
+) -> Response[BalancingEnergyActivatedVolumeHistoryResponse | Problem]:
+    """Get the revision history of the activated balancing energy volumes for an area
+
+     **Experimental** - This endpoint is under active development and may change without notice.
+
+    Returns how the activated balancing energy volumes on `/balancing/energy/activated-volumes`
+    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 `/balancing/energy/activated-volumes`
+    shape with `observedAt` added to each entry of `volumes`, 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.
+        reserve_type (ReserveType): Reserve type
+        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[BalancingEnergyActivatedVolumeHistoryResponse | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        area=area,
+        period_start_at=period_start_at,
+        period_end_at=period_end_at,
+        reserve_type=reserve_type,
+        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,
+    reserve_type: ReserveType,
+    cursor: str | Unset = UNSET,
+    limit: int | Unset = 100,
+    updated_since: datetime.datetime | Unset = UNSET,
+) -> BalancingEnergyActivatedVolumeHistoryResponse | Problem | None:
+    """Get the revision history of the activated balancing energy volumes for an area
+
+     **Experimental** - This endpoint is under active development and may change without notice.
+
+    Returns how the activated balancing energy volumes on `/balancing/energy/activated-volumes`
+    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 `/balancing/energy/activated-volumes`
+    shape with `observedAt` added to each entry of `volumes`, 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.
+        reserve_type (ReserveType): Reserve type
+        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:
+        BalancingEnergyActivatedVolumeHistoryResponse | Problem
+    """
+
+    return sync_detailed(
+        client=client,
+        area=area,
+        period_start_at=period_start_at,
+        period_end_at=period_end_at,
+        reserve_type=reserve_type,
+        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,
+    reserve_type: ReserveType,
+    cursor: str | Unset = UNSET,
+    limit: int | Unset = 100,
+    updated_since: datetime.datetime | Unset = UNSET,
+) -> Response[BalancingEnergyActivatedVolumeHistoryResponse | Problem]:
+    """Get the revision history of the activated balancing energy volumes for an area
+
+     **Experimental** - This endpoint is under active development and may change without notice.
+
+    Returns how the activated balancing energy volumes on `/balancing/energy/activated-volumes`
+    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 `/balancing/energy/activated-volumes`
+    shape with `observedAt` added to each entry of `volumes`, 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.
+        reserve_type (ReserveType): Reserve type
+        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[BalancingEnergyActivatedVolumeHistoryResponse | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        area=area,
+        period_start_at=period_start_at,
+        period_end_at=period_end_at,
+        reserve_type=reserve_type,
+        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,
+    reserve_type: ReserveType,
+    cursor: str | Unset = UNSET,
+    limit: int | Unset = 100,
+    updated_since: datetime.datetime | Unset = UNSET,
+) -> BalancingEnergyActivatedVolumeHistoryResponse | Problem | None:
+    """Get the revision history of the activated balancing energy volumes for an area
+
+     **Experimental** - This endpoint is under active development and may change without notice.
+
+    Returns how the activated balancing energy volumes on `/balancing/energy/activated-volumes`
+    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 `/balancing/energy/activated-volumes`
+    shape with `observedAt` added to each entry of `volumes`, 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.
+        reserve_type (ReserveType): Reserve type
+        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:
+        BalancingEnergyActivatedVolumeHistoryResponse | Problem
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            area=area,
+            period_start_at=period_start_at,
+            period_end_at=period_end_at,
+            reserve_type=reserve_type,
+            cursor=cursor,
+            limit=limit,
+            updated_since=updated_since,
+        )
+    ).parsed