feat(spot): add cl_ord_id to create_order and edit_order endpoints by claudiapacini · Pull Request #416 · btschwertfeger/python-kraken-sdk

claudiapacini · 2026-02-18T06:04:03Z

Summary

Adds the cl_ord_id for create order and edit order endpoints as per the docs:

Trade endpoints

https://docs.kraken.com/api/docs/rest-api/add-order
https://docs.kraken.com/api/docs/rest-api/amend-order
https://docs.kraken.com/api/docs/rest-api/cancel-order

User endpoints

https://docs.kraken.com/api/docs/rest-api/get-open-orders
https://docs.kraken.com/api/docs/rest-api/get-closed-orders
https://docs.kraken.com/api/docs/rest-api/get-orders-info

Closes the open issue:
python-kraken-sdk/issues/415.

btschwertfeger

Hey @claudiapacini, thanks for bringing this up!

Initially, I wanted to reject your issue and PR as the idea does not align with the decision on discontinuing the specialized Market, User, Trade, etc clients as stated here. The recommended functions to achieve your goal (e.g. for Spot trading) are the SpotClient.request and SpotAsyncClient.request methods. It also introduces a breaking change to the amend_order function that relied on the extra_params usage and now requires setting txid or cl_ord_id.

But after going through your changes, I see the benefit in applying them especially considering that the cancel_order function currently does not support client order IDs. While I still don't have the capacity to continuously track Kraken API changes, it makes sense to keep these specialized clients reasonably up to date with the help of contributors like you. This is particularly important not only from a functional perspective, but also because many users are likely still relying on the legacy client interfaces. Since the parameters are mostly optional, the risk of introducing future breaking changes also remains relatively low. So I'm happy to accept your proposed changes once you address my remaining comments.

btschwertfeger · 2026-02-21T09:06:02Z

src/kraken/spot/trade.py

+    def amend_order(  # pylint: disable=too-many-arguments # noqa: PLR0913, PLR0917
        self: Trade,
+        txid: str | None = None,
+        cl_ord_id: str | None = None,
+        order_qty: str | float | None = None,
+        display_qty: str | float | None = None,
+        limit_price: str | float | None = None,
+        trigger_price: str | float | None = None,
+        post_only: bool | None = None,
+        userref: int | None = None,
+        validate: bool = False,


Some parameters from the list are still missing https://docs.kraken.com/api/docs/rest-api/amend-order/.

i've double checked these. They should be ok now.

I don't see a validate parameter in the docs but it seems to work here as well.
Lets not add it to the function signature to avoid breakage in case they remove the support for this undocumented parameter. Users can still set it via extra_params.

tests/spot/test_spot_trade.py

btschwertfeger · 2026-03-13T15:08:21Z

@claudiapacini, are you planning to address the created comments and suggestions?

claudiapacini · 2026-03-13T18:01:36Z

I have removed the breaking changes in amend_order and cancel_order. These were not required.

claudiapacini · 2026-03-13T18:01:58Z

@claudiapacini, are you planning to address the created comments and suggestions?

sorry for the delay

btschwertfeger · 2026-03-19T16:42:01Z

src/kraken/spot/trade.py

        :type validate: bool, optional
        :param userref: User reference id for example to group orders
        :type userref: int, optional
+        :param cl_ord_id: Client order id (optional)


The optional is given by the type declaration and not necessary at this place.

(Similar to other places; please address)

Suggested change

:param cl_ord_id: Client order id (optional)

:param cl_ord_id: Client order id

btschwertfeger · 2026-03-19T16:45:01Z

src/kraken/spot/trade.py

+    def amend_order(  # pylint: disable=too-many-arguments # noqa: PLR0913, PLR0917
        self: Trade,
+        txid: str | None = None,
+        cl_ord_id: str | None = None,
+        order_qty: str | float | None = None,
+        display_qty: str | float | None = None,
+        limit_price: str | float | None = None,
+        trigger_price: str | float | None = None,
+        post_only: bool | None = None,
+        userref: int | None = None,
+        validate: bool = False,


I don't see a validate parameter in the docs but it seems to work here as well.
Lets not add it to the function signature to avoid breakage in case they remove the support for this undocumented parameter. Users can still set it via extra_params.

btschwertfeger · 2026-03-19T16:45:21Z

src/kraken/spot/trade.py


+        :param txid: The txid of the order to edit
+        :type txid: str, optional
+        :param cl_ord_id: Client order id (optional)


Suggested change

:param cl_ord_id: Client order id (optional)

:param cl_ord_id: Client order id

btschwertfeger · 2026-03-19T16:54:26Z

src/kraken/spot/trade.py

+        :type nonce: int, optional
+        :param validate: Validate the order without placing on the market (default: ``False``)
+        :type validate: bool, optional
+        :raises ValueError: If both ``txid`` and ``cl_ord_id`` are not set


Not having txid or cl_ord_id results in kraken.exceptions.KrakenInvalidArgumentsError.

Suggested change

:raises ValueError: If both ``txid`` and ``cl_ord_id`` are not set

:raises kraken.exceptions.KrakenInvalidArgumentsError: If neither ``txid`` or ``cl_ord_id`` is set

btschwertfeger · 2026-03-19T17:03:50Z

src/kraken/spot/trade.py

@@ -632,21 +697,24 @@ def edit_order(  # pylint: disable=too-many-arguments # noqa: PLR0913, PLR0917
    @ensure_string("txid")


I looked up the docs and it seems like txid can be an integer as well, but cl_ord_id must be a string.

So lets swap these out:

Suggested change

@ensure_string("txid")

@ensure_string("cl_ord_id")

btschwertfeger · 2026-03-19T17:07:17Z

tests/spot/test_spot_trade.py

+        with pytest.raises(ValueError, match=r"Either txid or cl_ord_id must be set!"):
+            spot_auth_trade.cancel_order()


I do get kraken.exceptions.KrakenInvalidArgumentsError here.

btschwertfeger · 2026-03-19T17:11:48Z

@claudiapacini, are you planning to address the created comments and suggestions?

sorry for the delay

Same here, busy times. (:

claudiapacini requested a review from btschwertfeger as a code owner February 18, 2026 06:04

btschwertfeger assigned claudiapacini Feb 21, 2026

btschwertfeger added Should Something that should be implemented somewhere in the future Technical Dept labels Feb 21, 2026

btschwertfeger added this to the Upcoming Release milestone Feb 21, 2026

btschwertfeger requested changes Feb 21, 2026

View reviewed changes

btschwertfeger linked an issue Feb 21, 2026 that may be closed by this pull request

Add cl_ord_id to spot apis #415

Open

claudiapacini force-pushed the cl-ord-id branch from b1a630f to 8329e36 Compare March 13, 2026 17:57

Adds cl_ord_id spot endpoints

86f7d4f

claudiapacini force-pushed the cl-ord-id branch from 8329e36 to 86f7d4f Compare March 13, 2026 18:00

btschwertfeger reviewed Mar 19, 2026

View reviewed changes

	:param cl_ord_id: Client order id (optional)
	:param cl_ord_id: Client order id

	:raises ValueError: If both ``txid`` and ``cl_ord_id`` are not set
	:raises kraken.exceptions.KrakenInvalidArgumentsError: If neither ``txid`` or ``cl_ord_id`` is set

		@@ -632,21 +697,24 @@ def edit_order( # pylint: disable=too-many-arguments # noqa: PLR0913, PLR0917
		@ensure_string("txid")

		with pytest.raises(ValueError, match=r"Either txid or cl_ord_id must be set!"):
		spot_auth_trade.cancel_order()

Conversation

claudiapacini commented Feb 18, 2026

Summary

Uh oh!

btschwertfeger left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

btschwertfeger commented Mar 13, 2026

Uh oh!

claudiapacini commented Mar 13, 2026

Uh oh!

claudiapacini commented Mar 13, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

btschwertfeger commented Mar 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants