python-kraken-sdk

What's Changed

Fixed Bugs 🪲

• Resolve "The "level3" channel is missing in kraken.spot.ws_client.SpotWSClient.private_channel_names" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/270

Other Changes

• Improve test suite and remove unused workflows by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/263
• Bump step-security/harden-runner from 2.9.0 to 2.9.1 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/264
• Bump github/codeql-action from 3.25.15 to 3.26.0 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/265
• Bump github/codeql-action from 3.26.0 to 3.26.2 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/266
• Bump github/codeql-action from 3.26.2 to 3.26.5 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/268
• Bump actions/setup-python from 5.1.1 to 5.2.0 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/271
• Bump github/codeql-action from 3.26.5 to 3.26.6 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/272
• Bump pypa/gh-action-pypi-publish from 1.9.0 to 1.10.0 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/273
• Bump pypa/gh-action-pypi-publish from 1.10.0 to 1.10.1 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/274

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v3.1.0...v3.1.1

What's Changed

Implemented Enhancements 🎉

• Add proxy support for futures and spot clients (async and sync) by @Graeme22 in https://github.com/btschwertfeger/python-kraken-sdk/pull/257

Other Changes

• CI: Change rules for harden-runner job in codeql by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/245
• Bump actions/dependency-review-action from 2.5.1 to 4.3.3 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/243
• Bump github/codeql-action from 2.2.4 to 3.25.11 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/246
• Bump actions/download-artifact from 4.1.7 to 4.1.8 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/247
• Bump dependabot/fetch-metadata from 2.1.0 to 2.2.0 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/248
• Bump github/codeql-action from 3.25.11 to 3.25.12 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/250
• Bump actions/setup-python from 5.1.0 to 5.1.1 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/249
• Bump actions/dependency-review-action from 4.3.3 to 4.3.4 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/251
• Skip test which requires to be executed from an institutional account by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/253
• Bump github/codeql-action from 3.25.12 to 3.25.13 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/254
• Bump step-security/harden-runner from 2.8.1 to 2.9.0 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/255
• Update the CI environment URL by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/258
• Bump ossf/scorecard-action from 2.3.3 to 2.4.0 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/259
• Bump github/codeql-action from 3.25.13 to 3.25.15 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/260
• Update the CI trigger rules to allow workflow runs on pull requests from outside this repository by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/262

New Contributors

• @Graeme22 made their first contribution in https://github.com/btschwertfeger/python-kraken-sdk/pull/257

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v3.0.0...v3.1.0

What's Changed

Breaking Changes ⚠️

• Preparations - v3.0.0 by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/230
• Resolve "The base class for websocket clients should be capable to execute requests asynchronously " by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/239
• Resolve "Remove deprecated Spot staking client" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/237
• Resolve "Remove deprecated Spot websocket client (v1) and order book client (v1)" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/236
• Resolve "Websocket Logic Refactor - start/stop mechanism" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/233

Features

• Resolve "Add modifiably Nonce" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/242
• Add async REST API by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/issues/228

Other Changes

• Bump actions/checkout from 4.1.6 to 4.1.7 by @dependabot in https://github.com/btschwertfeger/python-kraken-sdk/pull/241

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v2.3.0...v3.0.0
Milestone: https://github.com/btschwertfeger/python-kraken-sdk/milestone/18?closed=1

What's Changed

Implemented Enhancements 🎉

• Resolve "Add command-line interface" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/224

Fixed Bugs 🪲

• Resolve "Subscribing to "balances" channel using KrakenSpotWSClientV2 fails" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/229

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v2.2.0...v2.3.0

What's Changed

Implemented Enhancements 🎉

• Resolve "Add processBefore parameter to kraken.futures.Trade.{cancel_order,edit_order,create_order,create_batch_order}" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/192
• Resolve "Add kraken.futures.Trade.get_max_order_size" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/193
• Resolve "Mark kraken.spot.Staking as deprecated and add kraken.spot.Earn" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/199
• Resolve "Add ledger parameter to kraken.spot.User.get_trades_history" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/195
• Resolve "Add NFT support: kraken.nft.Trade and kraken.nft.Market" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/200

Other Changes

• Project Housekeeping by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/184
• Adjust the kraken.futures.User documentation by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/185
• Merge the CI/CD and release workflow + fix scheduled execution by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/186
• adjust CI configuration by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/187
• Resolve "The POST and query parameters of KrakenSpotBaseAPI and KrakenFuturesBaseAPI are not proper encoded in some case" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/189
• Resolve "Mark kraken.spot.KrakenSpotWSClientV1 as deprecated" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/201

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v2.1.1...v2.2.0

What's Changed

Fixed Bugs 🪲

• Fix "Futures re-subscribe to authenticated feed doesn't work" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/180

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v2.1.0...v2.1.1

What's Changed

Implemented Enhancements 🎉

• Resolve "Add withdraw_methods and withdraw_addresses to kraken.spot.Funding" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/175
• Resolve "Add start, end, and cursor parameters to kraken.spot.Funding.get_recent_withdraw_status" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/177

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v2.0.0...v2.1.0

What's Changed

Breaking Changes ⚠️

• Resolve "Drop Support for Python < 3.11" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/157
• Resolve "Rename KrakenBaseSpotAPI to KrakenSpotBaseAPI and KrakenBaseFuturesAPI to KrakenFuturesBaseAPI" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/159
• Resolve "Rename kraken.spot.KrakenSpotWSClient to kraken.spot.KrakenSpotWSClientV1" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/160
• Resolve "Extract the Kraken* exception classes from kraken.exceptions.KrakenException" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/162

Implemented Enhancements 🎉

• Resolve "Add optional extra_params to any requesting function" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/155
• Resolve "150 add the legacy OrderbookClient for Krakens websocket API v1" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/151
• Resolve "Add start, end, and cursor parameters to kraken.spot.Funding.get_recent_deposits_status" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/170
• Resolve "Add max_fee parameter to kraken.spot.Funding.withdraw_funds" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/171

Other Changes

• Resolve "163 uniform the msg parameter" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/164
• Resolve "Use Apache 2.0 license instead of GNU GPLv3" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/167
• Apply hints suggested by the ruff linter by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/165
• Adjust docstrings and documentation by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/172

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v1.6.2...v2.0.0

What's Changed

Fixed Bugs 🪲

• Fix "kraken.spot.OrderbookClient is not able to resubscribe to book feeds after connection lost" by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/149

Other Changes

• Bump Pre-Commit hook versions and adjust typing by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/146

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v1.6.1...v1.6.2

What's Changed

Fixed Bugs 🪲

• Adjust logging and examples; add PyLint check by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/144

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v1.6.0...v1.6.1

What's Changed

Breaking Changes ⚠️

• Integrate Kraken Websockets API v2; add kraken.spot.KrakenSpotWebsocketClientV2; internals by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/131
• Let kraken.spot.OrderbookClient use Spot Websocket API v2 by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/139
• Integrate and apply ruff by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/142

Implemented Enhancements 🎉

• Add /private/AccountTransfer endpoint -> kraken.spot.User.account_transfer by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/129

Other Changes

• Enable Windows builds within the CI by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/135
• Merge .pylintrc and pyproject.toml by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/137

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v1.5.0...v1.6.0

What's Changed

Breaking Changes 🛠

• kraken.spot.OrderbookClient: add timestamps to book's ask and bid values by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/124

Other Changes

• Add "Question" issue template by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/122
• Adjust project properties by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/123

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v1.4.1...v1.5.0

What's Changed

Fixed Bugs 🪲

• Fix kraken.spot.Market.get_recent_trades parameter 'since' by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/120

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v1.4.0...v1.4.1

What's Changed

Implemented Enhancements 🎉

• Add the truncate parameter to the Spot websocket clients' create_order and cancel_order+ kraken.spot.Trade.edit_order by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/113
• A the Spot order book client (kraken.spot.OrderbookClient) by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/106

Other Changes

• Update /examples/spot_orderbook.py by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/110
• Create release.yaml by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/116

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v1.3.0...v1.4.0

Including access to:

✅ - all Spot REST endpoints
✅ - all Futures REST endpoints
✅ - Spot Websocket client
✅ - Futures Websocket client
✅ - extensive examples
✅ - Documentation

Breaking changes:

• Rename kraken.futures.User.get_unwindqueue to kraken.futures.User.get_unwind_queue #107
• Prepare release v1.3.0 #99 (btschwertfeger)
• Change kraken.spot.User.get_balances and add kraken.spot.User.get_balance #98 (btschwertfeger)
• Rename get_tradeable_asset_pair to get_asset_pairs and make the pair parameter optional #93 (btschwertfeger)
• Extend typing + add KrakenUnknownMethodError and KrakenBadRequestError + Fix #65 #87 (btschwertfeger)

Implemented enhancements:

• kraken.spot.Trade.create_order: Ability to use floats as trade amounts or prices #94
• /public/AssetPairs would be nice. #90
• Improve caching #102 (btschwertfeger)
• Add the truncate parameter to kraken.spot.Trade.create_order #95 (btschwertfeger)

Fixed bugs:

• kraken.spot.User(...).get_balances('ZUSD') silently does the wrong thing. #88
• kraken.spot.Trade.cancel_order_batch endpoint in Spot trading does not work. {'error': ['EAPI:Bad request']} #65

Closed issues:

• Add a realtime Spot order book example #103
• kraken.spot.Trade.create_order: documentatoin for txid outdated. #96
• Create CONTRIBUTING.md #91
• Extend the typing - using mypy #84

Uncategorized merged pull requests:

• Create a contribution guideline #92 (btschwertfeger)

PyPI: https://pypi.org/project/python-kraken-sdk/
Documentation: https://python-kraken-sdk.readthedocs.io/en/stable/

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v1.2.0...v1.3.0

Including access to:

✅ - all Spot REST endpoints
✅ - all Futures REST endpoints
✅ - Spot Websocket client
✅ - Futures Websocket client
✅ - extensive examples
✅ - Documentation

Breaking Changes

• Fix bug/typo: "recend" -> recent throughout kraken.spot by @jcr-jeff in https://github.com/btschwertfeger/python-kraken-sdk/pull/76
• Add API rate limit exception; extend test doc strings by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/79

More Changes, Features and Bug Fixes

• Fix and extend release workflow by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/68
• Fix PyPI upload job + extend disclaimer by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/70
• Add a Changelog by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/73
• Removed matrix from CodeQL job by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/74
• Split the unit tests into individual files by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/75
• Fixed bug where spot.user.get_balances floats to periodic X.9999... by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/78
• Add Futures user endpoints: check_trading_enabled_on_subaccount and set_trading_on_subaccount by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/80
• Disable custom Kraken exceptions (optional) by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/82
• Let REST and websocket clients be used as context manager by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/83

New Contributors

• @jcr-jeff made their first contribution in https://github.com/btschwertfeger/python-kraken-sdk/pull/76

PyPI: https://pypi.org/project/python-kraken-sdk/
Documentation: https://python-kraken-sdk.readthedocs.io/en/stable/
Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v1.1.0...v1.2.0

Including access to:

✅ - all Spot REST endpoints
✅ - all Futures REST endpoints
✅ - Spot Websocket client
✅ - Futures Websocket client
✅ - extensive examples
✅ - about 86% coverage

Breaking Changes

• removed the unnecessary client when importing clients by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/59
• The KrakenExceptions-class was renamed to KrakenException and moved from kraken.exceptions.exceptions to kraken.exceptions (#66)
• The methods get_execution_events, get_order_events, and get_trigger_events moved from kraken.futures.Market to kraken.futures.User since this are user-specific endpoints. In addition, the bug from #62 was fixed by changing post_params to query_params within kraken.futures.User._get_historical_events function, since this is only a GET request, instead of a POST request.
• Changed the default timeout of kraken.futures.Trade.death_mans_switch to zero (which resets the timeout). (#63)

More Changes, Features and Bug Fixes

• added the user/developer documentation using sphinx build in the docs directory (#58)
• added doc strings and examples which are also included in the build documentation (#55)
• added workflow to build the documentation (#60)
• added codecov.yml configuration file
• Add the trailingStopDeviationUnit and trailingStopMaxDeviation parameters to the create_order method of the Futures Trade client. (#64)
• Rework workflows for CI/CD by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/53
• Moved from setup.py only to pyproject.toml by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/52
• Removed raising exception when currency not found in portfolio by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/47

PyPI: https://pypi.org/project/python-kraken-sdk/
Documentation: https://python-kraken-sdk.readthedocs.io/en/stable/

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v1.0.1...v1.1.0

Including access to:

✅ - all Spot REST endpoints
✅ - all Futures REST endpoints
✅ - Spot Websocket client
✅ - Futures Websocket client
✅ - extensive examples
✅ - about 85% coverage

What's Changed

• examples now use os.getenv instead of python-dotenv by @btschwertfeger in https://github.com/btschwertfeger/Python-Kraken-SDK/pull/34
• Apply pre-commit and adjust workflows by @btschwertfeger in https://github.com/btschwertfeger/Python-Kraken-SDK/pull/35
• Use workflow_dispatch to only trigger tests with python<python3.11 manually by @btschwertfeger in https://github.com/btschwertfeger/Python-Kraken-SDK/pull/43
• Apply kraken api changelog until mar 27 2023 by @btschwertfeger in https://github.com/btschwertfeger/Python-Kraken-SDK/pull/40
  • Added create_subaccount endpoint to kraken.spot.client.User (only for institutional clients).
  • get_recend_deposits_status and get_recend_withdraw_status in kraken.spot.client.Funding do not require the asset parameter anymore.
  • The reduce_only parameter was added to the kraken.spot.client.Trade.create_order method.
  • The consolidate_trades parameter was added to kraken.spot.client.User.get_orders_info.
• Release v1.0.1 by @btschwertfeger in https://github.com/btschwertfeger/Python-Kraken-SDK/pull/44

Full Changelog: https://github.com/btschwertfeger/Python-Kraken-SDK/compare/v1.0.0...v1.0.1

PyPI: https://pypi.org/project/python-kraken-sdk/

Including access to:

✅ - all Spot REST endpoints
✅ - all Futures REST endpoints
✅ - Spot Websocket client
✅ - Futures Websocket client
✅ - extensive examples
✅ - about 85% coverage

What's Changed

• Add unit tests #2 by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/30
• Extended CI/CD by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/31
• Extend unittests by @btschwertfeger in https://github.com/btschwertfeger/python-kraken-sdk/pull/32
• code style
• extended examples
• adjusted readme

Have fun with it! 🔥

https://pypi.org/project/python-kraken-sdk/

Full Changelog: https://github.com/btschwertfeger/python-kraken-sdk/compare/v0.8.0...v1.0.0

• Bug fixes in futures endpoints
• Added unit tests