v0.15.0

Frequenz Electricity Trading API Client Release Notes

Summary

Upgrading

• DeliveryPeriod instances now require a DeliveryDuration as an argument in their constructors, and can't be instantiated from timedeltas any more. Instead, DeliveryDurations can be created from timedelta instances with DeliveryDuration.from_timedelta().

• Timestamps are no-longer automatically converted to UTC. If provided timestamps are not in UTC, the client will raise an exception.

New Features

Bug Fixes

What's Changed

• chore(deps-dev): bump pydoclint from 0.7.3 to 0.7.6 by @dependabot[bot] in #211
• chore(deps): bump actions/download-artifact from 5 to 6 by @dependabot[bot] in #205
• chore(deps-dev): bump the patch group with 5 updates by @dependabot[bot] in #207
• chore(deps-dev): bump the minor group across 1 directory with 4 updates by @dependabot[bot] in #215
• chore(deps-dev): bump pylint from 3.3.8 to 4.0.2 by @dependabot[bot] in #212
• Change all client types to be frozen datatypes by @shsms in #214

Full Changelog: v0.14.0...v0.15.0

v0.14.0

Frequenz Electricity Trading API Client Release Notes

Summary

This release adds enhanced filtering capabilities for gridpool orders and trades, with support for tag-based filtering and more flexible time-based queries.

New Features

• Tag filtering for gridpool trades: The gridpool_trades() method now accepts a tag parameter to filter trades by tag. The GridpoolTradeFilter dataclass has been updated accordingly.

• Flexible time filtering with DeliveryTimeFilter: Replaced the restrictive delivery_period parameter with a more flexible delivery_time_filter across gridpool orders and trades methods. The new DeliveryTimeFilter supports:

  • Time interval filtering with optional start/end times
  • Multiple delivery duration filters
  • More granular control over time-based queries

• New types for time filtering: Added Interval and DeliveryTimeFilter types to support the enhanced filtering API.

• Support tags in CLI create-order command.

Breaking Changes

• The delivery_period parameter has been replaced with delivery_time_filter in the following methods:

  • list_gridpool_orders()
  • stream_gridpool_orders()
  • gridpool_trades()

  Note: The create_gridpool_order() method maintains backward compatibility by keeping both parameters.

• Updated API imports from v1 to v1alpha8 for common types.

What's Changed

• chore(deps): bump actions/download-artifact from 4 to 5 by @dependabot[bot] in #186
• chore(deps): bump actions/checkout from 4 to 5 by @dependabot[bot] in #187
• chore(deps): bump setuptools-scm[toml] from 8.3.1 to 9.2.0 by @dependabot[bot] in #188
• chore(deps): bump pydoclint from 0.6.6 to 0.7.0 by @dependabot[bot] in #189
• chore(deps): bump the patch group with 4 updates by @dependabot[bot] in #191
• chore(deps): bump types-protobuf from 6.30.2.20250703 to 6.30.2.20250822 by @dependabot[bot] in #190
• chore(deps): bump mkdocstrings-python from 1.17.0 to 1.18.2 in the mkdocstrings group by @dependabot[bot] in #192
• Support tags in CLI create-order command by @cwasicki in #193
• chore(deps): bump pydoclint from 0.7.0 to 0.7.3 by @dependabot[bot] in #199
• chore(deps): bump pandas-stubs from 2.3.2.250827 to 2.3.2.250926 by @dependabot[bot] in #200
• chore(deps): bump pytest-asyncio from 1.1.0 to 1.2.0 by @dependabot[bot] in #198
• chore(deps): bump the patch group with 4 updates by @dependabot[bot] in #196
• chore(deps): bump actions/labeler from 5.0.0 to 6.0.1 by @dependabot[bot] in #194
• chore(deps): bump actions/setup-python from 5 to 6 by @dependabot[bot] in #195
• chore(deps): bump the minor group with 8 updates by @dependabot[bot] in #197
• Fix tests namespace pollution from entsoe and remove tests/init by @Marenz in #201
• Enhance filtering capabilities by @phillip-wenig-frequenz in #204

New Contributors

• @phillip-wenig-frequenz made their first contribution in #204

Full Changelog: v0.13.0...v0.14.0

v0.13.0

Frequenz Electricity Trading API Client Release Notes

Summary

Upgrading

• Widen the version range of api-common to also allow v0.8.x.
• Restrict entsoe client dependency version range up to v0.7.x.
• Listing gridpool orders that do not contain a price or quantity no longer raises an exception. Users must validate orders themselves.

New Features

Bug Fixes

• Fixed typo in the trading CLI help text.

What's Changed

• Fix typo in trading CLI help text by @daniel-zullo-frequenz in #166
• chore(deps): bump frequenz-floss/gh-action-nox from 1.0.0 to 1.0.1 by @dependabot[bot] in #167
• chore(deps): bump frequenz-floss/gh-action-setup-python-with-deps from 1.0.0 to 1.0.1 by @dependabot[bot] in #168
• chore(deps): bump async-solipsism from 0.7 to 0.8 by @dependabot[bot] in #176
• chore(deps): bump types-protobuf from 6.30.2.20250516 to 6.30.2.20250703 by @dependabot[bot] in #173
• chore(deps): update frequenz-api-common requirement from <0.8.0,>=0.6.5 to >=0.6.5,<0.9.0 by @dependabot[bot] in #175
• chore(deps): bump the minor group across 1 directory with 2 updates by @dependabot[bot] in #181
• chore(deps): bump types-markdown from 3.8.0.20250415 to 3.8.0.20250708 by @dependabot[bot] in #172
• chore(deps): bump pytest-asyncio from 1.0.0 to 1.1.0 by @dependabot[bot] in #174
• chore(deps): bump mkdocs-material from 9.6.15 to 9.6.16 in the patch group by @dependabot[bot] in #169
• chore(deps): bump the mkdocstrings group across 1 directory with 2 updates by @dependabot[bot] in #183
• Restrict entsoe dependency version range by @cwasicki in #184
• Support listing gridpool orders without price or quantity by @cwasicki in #182

Full Changelog: v0.12.1...v0.13.0

v0.12.2

Frequenz Electricity Trading API Client Release Notes

Summary

This release relaxes the API common dependency so it can work up to v1.0.0, as all v0.x versions should be compatible from v0.6.x on.

What's Changed

• Relax the dependency on frequenz-api-common to allow up to 1.0.0 by @llucax in #185

New Contributors

• @llucax made their first contribution in #185

Full Changelog: v0.12.1...v0.12.2

v0.12.1

Frequenz Electricity Trading API Client Release Notes

Bug Fixes

• Fixed a public order book stream bug where a stream was reused for requests with different start and stop time parameters.

What's Changed

• Reset release notes by @cwasicki in #161
• Fix and update integration tests by @daniel-zullo-frequenz in #163
• Fix bug in public order book streaming code by @matthias-wende-frequenz in #164
• Prepare release notes for release by @matthias-wende-frequenz in #165

Full Changelog: v0.12.0...v0.12.1

v0.12.0

Frequenz Electricity Trading API Client Release Notes

Upgrading

New Features

• Added HMAC capabilities
• Add option to request public order data from the API.

Bug Fixes

What's Changed

• Add HMAC capabilities by @florian-wagner-frequenz in #152
• Add option to request public orders to CLI tool by @cwasicki in #154
• Clear release notes by @cwasicki in #153
• Bump the patch group with 7 updates by @dependabot[bot] in #155
• Bump the minor group with 2 updates by @dependabot[bot] in #156
• Bump types-protobuf from 5.29.1.20250403 to 6.30.2.20250516 by @dependabot[bot] in #160
• Bump pytest-asyncio from 0.26.0 to 1.0.0 by @dependabot[bot] in #159
• Update frequenz-api-common requirement from <0.7.0,>=0.6.5 to >=0.6.5,<0.8.0 by @dependabot[bot] in #158
• Bump pandas-stubs from 2.2.3.250308 to 2.2.3.250527 by @dependabot[bot] in #157

New Contributors

• @florian-wagner-frequenz made their first contribution in #152

Full Changelog: v0.11.0...v0.12.0

v0.11.0

Frequenz Electricity Trading API Client Release Notes

Upgrading

• The minimum allowed version of protobuf and grpcio has been updated to 6.31.1 and 1.72.1 respectively.

New Features

• Updated to v0.8.0 of the Electricity Trading API.
• Updated to v0.11.0 of the base client library.

Bug Fixes

• Added OrderType field to PublicOrder class.

What's Changed

• Require most arguments to client methods to be kw-only by @shsms in #141
• Bump setuptools from 79.0.0 to 80.1.0 by @dependabot in #138
• Bump the patch group across 1 directory with 5 updates by @dependabot in #142
• Update usage examples by @matthias-wende-frequenz in #143
• Improve mypy compliance with sentinel values by @shsms in #145
• Bump the minor group across 1 directory with 4 updates by @dependabot in #148
• Bump mkdocstrings-python from 1.16.10 to 1.16.11 in the patch group by @dependabot in #146
• Bump grpc-stubs from 1.53.0.5 to 1.53.0.6 by @dependabot in #137
• Update to electricity trading API v0.0.8 by @matthias-wende-frequenz in #150
• Bump black from 24.10.0 to 25.1.0 by @dependabot in #136

Full Changelog: v0.10.0...v0.11.0

v0.10.0

Frequenz Electricity Trading API Client Release Notes

New Features

• Update to API v0.7.0

Bug Fixes

• Ensure timestamp conversion errors are surfaced
• Use HasField to check explicit field precedence

What's Changed

• Bump nox from 2024.10.9 to 2025.2.9 by @dependabot in #130
• Bump the minor group with 8 updates by @dependabot in #123
• Bump the patch group with 6 updates by @dependabot in #122
• Bump the mkdocstrings group with 2 updates by @dependabot in #124
• Ensure timestamp conversion errors are surfaced by @matthias-wende-frequenz in #133
• Bump pytest-asyncio from 0.24.0 to 0.26.0 by @dependabot in #131
• Bump setuptools from 75.6.0 to 79.0.0 by @dependabot in #129
• Bump pydoclint from 0.5.9 to 0.6.6 by @dependabot in #128
• Update protobuf requirement from <6,>=5.29.2 to >=5.29.2,<7 by @dependabot in #127
• Bump isort from 5.13.2 to 6.0.1 by @dependabot in #126
• Update to API v0.7.0 by @matthias-wende-frequenz in #139
• Use HasField to check explicit field presedence by @matthias-wende-frequenz in #140

Full Changelog: v0.0.9...v0.10.0

v0.0.9

Frequenz Electricity Trading API Client Release Notes

Summary

Upgrading

• Unify Public Trades streaming and listing (to align with the proto changes in v0.5.0)
  • Removed list_public_trades
  • Replaced public_trades_stream with receive_public_trades
  • receive_public_trades now supports an optional time range (start_time, end_time)
• Update the frequenz-api-electricity-trading from >= 0.5.0, < 0.6.0 to >= 0.6.1, < 0.7.0
• Update repo-config from v0.11.0 to v0.13.0

New Features

• Add the Public Order Book extension to the client
  • Add the PublicOrder and PublicOrderFilter types
  • Add the receive_public_order() endpoint

Bug Fixes

What's Changed

• Update repo-config from v0.11.0 to v0.13.0 by @camille-bouvy-frequenz in #117
• Add the public order book extension to the Client by @camille-bouvy-frequenz in #120
• Convert timestamp to UTC by @matthias-wende-frequenz in #132

New Contributors

• @matthias-wende-frequenz made their first contribution in #132

Full Changelog: v0.8.0...v0.0.9

v0.8.0

Frequenz Electricity Trading API Client Release Notes

Summary

Upgrading

• Unify Public Trades streaming and listing (to align with the proto changes in v0.5.0)
  • Removed list_public_trades
  • Replaced public_trades_stream with receive_public_trades
  • receive_public_trades now supports an optional time range (start_time, end_time)

New Features

Bug Fixes

What's Changed

• Unify public trades streaming and listing by @camille-bouvy-frequenz in #112
• Update release notes after creating tag by @cwasicki in #116

Full Changelog: v0.7.0...v0.8.0