Add basic tests for xstocks feature

Author: btschwertfeger

pyproject.toml

@@ -94,6 +94,7 @@ markers = [
   "wip: Used to run a specific test by hand.",
   "flaky: Flaky tests",
   "spot: Spot endpoint.",
+  "xstocks: Spot xStocks endpoint.",
   "spot_auth: Private Spot endpoint.",
   "spot_earn: Spot Earn endpoint.",
   "spot_trade: Spot Trade endpoint.",

src/kraken/base_api/__init__.py

@@ -191,6 +191,9 @@ class SpotClient:
     This class is the base for all Spot clients, handles un-/signed requests and
     returns exception handled results.
 
+    With this class you can easily interact with the Kraken Spot API, including
+    trading Spot crypto assets, xStocks, and margin trading.
+
     If you are facing timeout errors on derived clients, you can make use of the
     ``TIMEOUT`` attribute to deviate from the default ``10`` seconds.
 

tests/futures/test_futures_trade.py

@@ -10,7 +10,7 @@
 from collections.abc import Generator
 from contextlib import suppress
 from time import sleep
-from typing import Any, Self
+from typing import Any, ClassVar, Self
 
 import pytest
 
@@ -58,13 +58,10 @@ class TestFuturesTrade:
     REDUCE_ONLY = True
     PROCESS_BEFORE = "3033-11-08T19:56:35.441899Z"
     LAST_FILL_TIME = "2020-07-21T12:41:52.790Z"
-    TEST_ORDER_IDS = None
-
-    def __init__(self) -> None:
-        self.TEST_ORDER_IDS = [
-            "bcaaefce-27a3-44b4-b13a-19df21e3f087",
-            "685d5a1a-23eb-450c-bf17-1e4ab5c6fe8a",
-        ]
+    TEST_ORDER_IDS: ClassVar[list[str]] = [
+        "bcaaefce-27a3-44b4-b13a-19df21e3f087",
+        "685d5a1a-23eb-450c-bf17-1e4ab5c6fe8a",
+    ]
 
     def _assert_successful_response(self: Self, result: Any) -> None:
         """Helper method to assert a successful response."""

tests/spot/conftest.py

@@ -13,12 +13,20 @@
 
 import pytest
 
-from kraken.spot import Earn, Funding, Market, Trade, User
+from kraken.spot import Earn, Funding, Market, SpotClient, Trade, User
 
 SPOT_API_KEY: str = os.getenv("SPOT_API_KEY")
 SPOT_SECRET_KEY: str = os.getenv("SPOT_SECRET_KEY")
+XSTOCKS_API_KEY: str = os.getenv("XSTOCKS_API_KEY")
+XSTOCKS_SECRET_KEY: str = os.getenv("XSTOCKS_SECRET_KEY")
+XSTOCKS_API_URL: str = os.getenv(
+    "XSTOCKS_API_URL",
+    "https://api.vip.uat.lobster.kraken.com",
+)
 
 
+# ==============================================================================
+# Spot Crypto
 @pytest.fixture(scope="session")
 def spot_api_key() -> str:
     """Returns the Kraken Spot API Key for testing."""
@@ -93,3 +101,45 @@ def spot_auth_funding() -> Funding:
     Fixture providing an authenticated Spot funding client.
     """
     return Funding(key=SPOT_API_KEY, secret=SPOT_SECRET_KEY)
+
+
+# ==============================================================================
+# Spot xStocks
+@pytest.fixture(scope="session")
+def xstocks_api_key() -> str:
+    """Returns the Kraken xStocks API Key for testing."""
+    return XSTOCKS_API_KEY
+
+
+@pytest.fixture(scope="session")
+def xstocks_secret_key() -> str:
+    """Returns the Kraken xStocks API secret for testing."""
+    return XSTOCKS_SECRET_KEY
+
+
+@pytest.fixture(scope="session")
+def xstocks_client() -> SpotClient:
+    """
+    Fixture providing an authenticated Spot client.
+    """
+    return SpotClient(
+        key=XSTOCKS_API_KEY,
+        secret=XSTOCKS_SECRET_KEY,
+        url=XSTOCKS_API_URL,
+    )
+
+
+@pytest.fixture(scope="session")
+def xstocks_market_client() -> SpotClient:
+    """
+    Fixture providing an authenticated Spot client.
+    """
+    return Market(key=XSTOCKS_API_KEY, secret=XSTOCKS_SECRET_KEY, url=XSTOCKS_API_URL)
+
+
+@pytest.fixture(scope="session")
+def xstocks_trade_client() -> SpotClient:
+    """
+    Fixture providing an authenticated Spot client.
+    """
+    return Trade(key=XSTOCKS_API_KEY, secret=XSTOCKS_SECRET_KEY, url=XSTOCKS_API_URL)

tests/spot/test_xstocks_basic.py

@@ -0,0 +1,91 @@
+# -*- mode: python; coding: utf-8 -*-
+#
+# Copyright (C) 2025 Benjamin Thomas Schwertfeger
+# All rights reserved.
+# https://github.com/btschwertfeger
+#
+
+"""Module that implements the unit tests for the Spot xStocks features."""
+
+from typing import ClassVar, Self
+
+import pytest
+
+from kraken.spot import Market, SpotClient, Trade
+
+
+@pytest.mark.spot
+@pytest.mark.xstocks
+class TestSpotXStocks:
+    """Test class for Spot xStocks client functionality."""
+
+    SAVE_ORDER: ClassVar[dict[str, str]] = {
+        "pair": "AAPLxUSD",
+        "ordertype": "limit",
+        "volume": "1",
+        "price": "100.0",
+        "validate": True,
+    }
+
+    def test_get_asset_pairs_market_client(
+        self: Self,
+        xstocks_market_client: Market,
+    ) -> None:
+        """
+        Checks the ``get_asset_pairs`` endpoint by performing a valid request
+        and validating that the response does not contain the error key.
+        """
+        # internal exception handling would catch any errors
+        result = xstocks_market_client.get_asset_pairs(
+            extra_params={"aclass_base": "tokenized_asset"},
+        )
+        assert isinstance(result, dict), result
+
+    def test_get_asset_pairs_spot_client(
+        self: Self,
+        xstocks_client: SpotClient,
+    ) -> None:
+        """
+        Checks the ``get_asset_pairs`` endpoint by performing a valid request
+        and validating that the response does not contain the error key.
+        """
+        # internal exception handling would catch any errors
+        result = xstocks_client.request(
+            "GET",
+            "/0/public/AssetPairs",
+            params={"aclass_base": "tokenized_asset"},
+            auth=False,
+        )
+        assert isinstance(result, dict), result
+
+    @pytest.mark.spot_auth
+    def test_create_order_trade_client(
+        self: Self,
+        xstocks_trade_client: Trade,
+    ) -> None:
+        """
+        Checks if the response of the ``create_order`` is of type dict which
+        mean that the request was successful.
+        """
+        result = xstocks_trade_client.create_order(
+            **self.SAVE_ORDER,
+            side="buy",
+            extra_params={"asset_class": "tokenized_asset"},
+        )
+        assert "AAPLxUSD" in result.get("descr", {}).get("order", "")
+
+    @pytest.mark.spot_auth
+    def test_create_order_spot_client(
+        self: Self,
+        xstocks_client: SpotClient,
+    ) -> None:
+        """
+        Checks if the response of the ``create_order`` is of type dict which
+        mean that the request was successful.
+        """
+        result = xstocks_client.request(
+            "POST",
+            "/0/private/AddOrder",
+            params={"type": "buy", "asset_class": "tokenized_asset"} | self.SAVE_ORDER,
+        )
+        assert "AAPLxUSD" in result.get("descr", {}).get("order", "")