Skip to content

Fix parameter forwarding in Spot Funding client and mark it as deprecated #464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
btschwertfeger merged 1 commit into from
Sep 27, 2026
Merged

Fix parameter forwarding in Spot Funding client and mark it as deprecated #464

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
169 changes: 165 additions & 4 deletions src/kraken/spot/funding.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,31 @@
from typing import Self

from kraken.base_api import SpotClient, defined
from kraken.utils.utils import deprecated

_FUNDING_LEGACY_NOTE = (
"will remain active but will no longer receive updates. Kraken is"
" introducing a new Funding (Beta) API with stable"
" method/network/address IDs, fee pinning, and cursor pagination."
" Review the Funding guide"
" (https://docs.kraken.com/exchange/guides/rest/funding). This method"
" keeps wrapping the legacy endpoint, so reach the new endpoints"
" through this client's request() method."
)


class Funding(SpotClient):
"""
.. deprecated::
Every endpoint wrapped by this class belongs to Kraken's Funding
(Legacy) API, which will remain active but will no longer receive
updates. Kraken is introducing a new Funding (Beta) API with stable
method/network/address IDs, fee pinning, and cursor pagination.
Review the `Funding guide
<https://docs.kraken.com/exchange/guides/rest/funding>`_. These
methods keep wrapping the legacy endpoints, so reach the new
endpoints through this client's ``request`` method.

Class that implements the Spot Funding client. Currently there are no
funding endpoints that could be accesses without authentication.

Expand Down Expand Up @@ -60,13 +81,27 @@ def __enter__(self: Self) -> Self:
super().__enter__()
return self

@deprecated(
f"The 'get_deposit_methods' function uses a deprecated Kraken endpoint,"
f" which {_FUNDING_LEGACY_NOTE}",
)
def get_deposit_methods(
self: Funding,
asset: str,
*,
extra_params: dict | None = None,
) -> list[dict]:
"""
.. deprecated::
This endpoint belongs to Kraken's Funding (Legacy) API, which
will remain active but will no longer receive updates. Kraken is
introducing a new Funding (Beta) API with stable
method/network/address IDs, fee pinning, and cursor pagination.
Review the `Funding guide
<https://docs.kraken.com/exchange/guides/rest/funding>`_. This
method keeps wrapping the legacy endpoint, so reach the new
endpoints through this client's ``request`` method.

Get the available deposit methods for a specific asset.

- https://docs.kraken.com/api/docs/rest-api/get-deposit-methods
Expand Down Expand Up @@ -102,6 +137,10 @@ def get_deposit_methods(
extra_params=extra_params,
)

@deprecated(
f"The 'get_deposit_address' function uses a deprecated Kraken endpoint,"
f" which {_FUNDING_LEGACY_NOTE}",
)
def get_deposit_address(
self: Funding,
asset: str,
Expand All @@ -111,12 +150,22 @@ def get_deposit_address(
extra_params: dict | None = None,
) -> list[dict]:
"""
.. deprecated::
This endpoint belongs to Kraken's Funding (Legacy) API, which
will remain active but will no longer receive updates. Kraken is
introducing a new Funding (Beta) API with stable
method/network/address IDs, fee pinning, and cursor pagination.
Review the `Funding guide
<https://docs.kraken.com/exchange/guides/rest/funding>`_. This
method keeps wrapping the legacy endpoint, so reach the new
endpoints through this client's ``request`` method.

Get the deposit addresses for a specific asset. New deposit addresses
can be generated.

Requires the ``Deposit funds`` API key permission.

- https://docs.kraken.com/api/docs/rest-api/get-deposit-addresses
- https://docs.kraken.com/api-reference/funding/get-deposit-addresses

:param asset: Asset being deposited
:type asset: str
Expand Down Expand Up @@ -155,6 +204,10 @@ def get_deposit_address(
extra_params=extra_params,
)

@deprecated(
f"The 'get_recent_deposits_status' function uses a deprecated Kraken"
f" endpoint, which {_FUNDING_LEGACY_NOTE}",
)
def get_recent_deposits_status(
self: Funding,
asset: str | None = None,
Expand All @@ -166,6 +219,16 @@ def get_recent_deposits_status(
extra_params: dict | None = None,
) -> list[dict] | dict:
"""
.. deprecated::
This endpoint belongs to Kraken's Funding (Legacy) API, which
will remain active but will no longer receive updates. Kraken is
introducing a new Funding (Beta) API with stable
method/network/address IDs, fee pinning, and cursor pagination.
Review the `Funding guide
<https://docs.kraken.com/exchange/guides/rest/funding>`_. This
method keeps wrapping the legacy endpoint, so reach the new
endpoints through this client's ``request`` method.

Get information about the recent deposit status. The look back period is
90 days and only the last 25 deposits will be returned.

Expand Down Expand Up @@ -248,6 +311,10 @@ def get_recent_deposits_status(
extra_params=extra_params,
)

@deprecated(
f"The 'withdraw_methods' function uses a deprecated Kraken endpoint,"
f" which {_FUNDING_LEGACY_NOTE}",
)
def withdraw_methods(
self: Funding,
asset: str | None = None,
Expand All @@ -257,6 +324,16 @@ def withdraw_methods(
extra_params: dict | None = None,
) -> dict:
"""
.. deprecated::
This endpoint belongs to Kraken's Funding (Legacy) API, which
will remain active but will no longer receive updates. Kraken is
introducing a new Funding (Beta) API with stable
method/network/address IDs, fee pinning, and cursor pagination.
Review the `Funding guide
<https://docs.kraken.com/exchange/guides/rest/funding>`_. This
method keeps wrapping the legacy endpoint, so reach the new
endpoints through this client's ``request`` method.

Returns the list of available withdraw methods for that user.

Requires the ``Funds permissions - Query`` and ``Funds permissions -
Expand All @@ -275,7 +352,7 @@ def withdraw_methods(
if defined(asset):
params["asset"] = asset
if defined(aclass):
params["network"] = aclass
params["aclass"] = aclass
if defined(network):
params["network"] = network
return self.request( # type: ignore[return-value]
Expand All @@ -285,6 +362,10 @@ def withdraw_methods(
extra_params=extra_params,
)

@deprecated(
f"The 'withdraw_addresses' function uses a deprecated Kraken endpoint,"
f" which {_FUNDING_LEGACY_NOTE}",
)
def withdraw_addresses(
self: Funding,
asset: str | None = None,
Expand All @@ -296,6 +377,16 @@ def withdraw_addresses(
extra_params: dict | None = None,
) -> dict:
"""
.. deprecated::
This endpoint belongs to Kraken's Funding (Legacy) API, which
will remain active but will no longer receive updates. Kraken is
introducing a new Funding (Beta) API with stable
method/network/address IDs, fee pinning, and cursor pagination.
Review the `Funding guide
<https://docs.kraken.com/exchange/guides/rest/funding>`_. This
method keeps wrapping the legacy endpoint, so reach the new
endpoints through this client's ``request`` method.

Returns the list of available withdrawal addresses for that user.

Requires the ``Funds permissions - Query`` and ``Funds permissions -
Expand All @@ -318,7 +409,7 @@ def withdraw_addresses(
if defined(asset):
params["asset"] = asset
if defined(aclass):
params["network"] = aclass
params["aclass"] = aclass
if defined(method):
params["method"] = method
if defined(key):
Expand All @@ -327,11 +418,15 @@ def withdraw_addresses(
params["verified"] = verified
return self.request( # type: ignore[return-value]
method="POST",
uri="/0/private/WithdrawMethods",
uri="/0/private/WithdrawAddresses",
params=params,
extra_params=extra_params,
)

@deprecated(
f"The 'get_withdrawal_info' function uses a deprecated Kraken endpoint,"
f" which {_FUNDING_LEGACY_NOTE}",
)
def get_withdrawal_info(
self: Funding,
asset: str,
Expand All @@ -341,6 +436,16 @@ def get_withdrawal_info(
extra_params: dict | None = None,
) -> dict:
"""
.. deprecated::
This endpoint belongs to Kraken's Funding (Legacy) API, which
will remain active but will no longer receive updates. Kraken is
introducing a new Funding (Beta) API with stable
method/network/address IDs, fee pinning, and cursor pagination.
Review the `Funding guide
<https://docs.kraken.com/exchange/guides/rest/funding>`_. This
method keeps wrapping the legacy endpoint, so reach the new
endpoints through this client's ``request`` method.

Get information about a possible withdraw, including fee and limit
information. The ``key`` must be the name of the key defined in the
account.
Expand Down Expand Up @@ -384,6 +489,10 @@ def get_withdrawal_info(
extra_params=extra_params,
)

@deprecated(
f"The 'withdraw_funds' function uses a deprecated Kraken endpoint,"
f" which {_FUNDING_LEGACY_NOTE}",
)
def withdraw_funds(
self: Funding,
asset: str,
Expand All @@ -394,6 +503,16 @@ def withdraw_funds(
extra_params: dict | None = None,
) -> dict:
"""
.. deprecated::
This endpoint belongs to Kraken's Funding (Legacy) API, which
will remain active but will no longer receive updates. Kraken is
introducing a new Funding (Beta) API with stable
method/network/address IDs, fee pinning, and cursor pagination.
Review the `Funding guide
<https://docs.kraken.com/exchange/guides/rest/funding>`_. This
method keeps wrapping the legacy endpoint, so reach the new
endpoints through this client's ``request`` method.

Create a new withdraw. The key must be the name of the withdraw key
defined in the withdraw section of the Kraken WebUI.

Expand Down Expand Up @@ -437,6 +556,10 @@ def withdraw_funds(
extra_params=extra_params,
)

@deprecated(
f"The 'get_recent_withdraw_status' function uses a deprecated Kraken"
f" endpoint, which {_FUNDING_LEGACY_NOTE}",
)
def get_recent_withdraw_status(
self: Funding,
asset: str | None = None,
Expand All @@ -448,6 +571,16 @@ def get_recent_withdraw_status(
extra_params: dict | None = None,
) -> list[dict]:
"""
.. deprecated::
This endpoint belongs to Kraken's Funding (Legacy) API, which
will remain active but will no longer receive updates. Kraken is
introducing a new Funding (Beta) API with stable
method/network/address IDs, fee pinning, and cursor pagination.
Review the `Funding guide
<https://docs.kraken.com/exchange/guides/rest/funding>`_. This
method keeps wrapping the legacy endpoint, so reach the new
endpoints through this client's ``request`` method.

Get information about the recent withdraw status, including withdraws of
the past 90 days but at max 500 results.

Expand Down Expand Up @@ -507,6 +640,10 @@ def get_recent_withdraw_status(
extra_params=extra_params,
)

@deprecated(
f"The 'cancel_withdraw' function uses a deprecated Kraken endpoint,"
f" which {_FUNDING_LEGACY_NOTE}",
)
def cancel_withdraw(
self: Funding,
asset: str,
Expand All @@ -515,6 +652,16 @@ def cancel_withdraw(
extra_params: dict | None = None,
) -> dict:
"""
.. deprecated::
This endpoint belongs to Kraken's Funding (Legacy) API, which
will remain active but will no longer receive updates. Kraken is
introducing a new Funding (Beta) API with stable
method/network/address IDs, fee pinning, and cursor pagination.
Review the `Funding guide
<https://docs.kraken.com/exchange/guides/rest/funding>`_. This
method keeps wrapping the legacy endpoint, so reach the new
endpoints through this client's ``request`` method.

Cancel a requested withdraw. This will only be successful if the
withdraw is not being processed so far.

Expand Down Expand Up @@ -545,6 +692,10 @@ def cancel_withdraw(
extra_params=extra_params,
)

@deprecated(
f"The 'wallet_transfer' function uses a deprecated Kraken endpoint,"
f" which {_FUNDING_LEGACY_NOTE}",
)
def wallet_transfer(
self: Funding,
asset: str,
Expand All @@ -555,6 +706,16 @@ def wallet_transfer(
extra_params: dict | None = None,
) -> dict:
"""
.. deprecated::
This endpoint belongs to Kraken's Funding (Legacy) API, which
will remain active but will no longer receive updates. Kraken is
introducing a new Funding (Beta) API with stable
method/network/address IDs, fee pinning, and cursor pagination.
Review the `Funding guide
<https://docs.kraken.com/exchange/guides/rest/funding>`_. This
method keeps wrapping the legacy endpoint, so reach the new
endpoints through this client's ``request`` method.

Transfer assets between the Spot and Futures wallet.

Requires the ``Withdraw funds`` API key permissions.
Expand Down
Loading