update: some fields, skip validation for output, add examples

examples/basic.py

@@ -105,7 +105,7 @@ async def example_authenticated_endpoints():
 
         # Get lightning deposits (last 5)
         deposits = await client.account.get_lightning_deposits(
-            GetLightningDepositsParams(from_="2022-01-01", limit=5)
+            GetLightningDepositsParams(from_="1970-01-01T00:00:00.000Z", limit=5)
         )
         print(f"\n--- Recent Lightning Deposits (Last {len(deposits)}) ---")
         for deposit in deposits:
@@ -136,7 +136,11 @@ async def example_authenticated_endpoints():
         try:
             print("\n--- Try to open a new cross order ---")
             order_params = FuturesCrossOrderLimit(
-                type="limit", price=1.5, quantity=1, side="b"
+                type="limit",
+                price=101000,
+                quantity=10,
+                side="s",
+                client_id="custom-ref-123",
             )
             new_order = await client.futures.cross.new_order(order_params)
             print(f"New order: {new_order}")

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 urls = { "Homepage" = "https://github.com/ln-markets/sdk-python", "Repository" = "https://github.com/ln-markets/sdk-python", "Bug Tracker" = "https://github.com/ln-markets/sdk-python/issues" }
 
 name = "lnmarkets-sdk"
-version = "0.0.11"
+version = "0.0.13"
 description = "LN Markets API Python SDK"
 readme = "README.md"
 license = { text = "MIT" }
@@ -42,6 +42,8 @@ dev = [
   { include-group = "test" },
   "python-dotenv>=1.0.1",
   "playwright>=1.40.0",
+  "faker>=37.12.0",
+  "faker-crypto>=1.0.1",
 ]
 lint = ["ruff>=0.12.0", "pyright>=1.1.390"]
 test = ["pytest", "pytest-asyncio", "pytest-httpx>=0.35.0"]

src/lnmarkets_sdk/v3/_internal/__init__.py

@@ -62,7 +62,7 @@ async def request(
             data = ""
             if params_dict:
                 if method == "GET":
-                    data = f"?{urlencode({k: str(v) for k, v in params_dict.items()})}"
+                    data = f"?{urlencode(params_dict)}"
                 else:
                     data = json.dumps(params_dict, separators=(",", ":"))
                     headers.update({"Content-Type": "application/json"})

src/lnmarkets_sdk/v3/_internal/models.py

@@ -14,7 +14,7 @@ class BaseConfig:
     """Base configuration for all Pydantic models."""
 
     model_config = ConfigDict(
-        extra="forbid",
+        extra="allow",
         validate_assignment=True,
         str_strip_whitespace=True,
         use_enum_values=True,

src/lnmarkets_sdk/v3/http/client/__init__.py

@@ -27,30 +27,40 @@ def __init__(self, config: APIClientConfig | None = None):
         Initialize the LN Markets client.
 
         Args:
-            config: Client configuration. If None, will use environment variables.
+            config: Client configuration
 
         Example:
-        >>> from src.lnmarkets_sdk.v3.client import LNMClient
-        >>> from src.lnmarkets_sdk.v3.types.api.base import APIClientConfig, APIAuthContext
-        >>>
-        >>> config = APIClientConfig(
-        ...     authentication=APIAuthContext(
-        ...         key="your-key",
-        ...         secret="your-secret",
-        ...         passphrase="your-passphrase",
-        ...     ),
-        ...     network="mainnet",
-        ... )
-        >>>
-        >>> async with LNMClient(config) as client:
-        ...     # Get account info
-        ...     account = await client.account.get_account()
-        ...
-        ...     # Get market ticker
-        ...     ticker = await client.futures.get_ticker()
-        ...
-        ...     # Place a futures order
-        ...     order = await client.futures.isolated.new_trade(params)
+        ```python
+        from lnmarkets_sdk.v3.http.client import LNMClient, APIClientConfig, APIAuthContext
+        from lnmarkets_sdk.v3.models.futures_isolated import FuturesOrder
+
+        config = APIClientConfig(
+            authentication=APIAuthContext(
+                key="your-key",
+                secret="your-secret",
+                passphrase="your-passphrase",
+            ),
+            network="mainnet",
+            timeout=30,
+        )
+
+        async with LNMClient(config) as client:
+            # Get account info
+            account = await client.account.get_account()
+
+            # Get market ticker
+            ticker = await client.futures.get_ticker()
+
+            # Place a futures order
+            params = FuturesOrder(
+                type="l",  # limit order
+                side="b",  # buy
+                price=100_000,
+                quantity=1,
+                leverage=100,
+            )
+            order = await client.futures.isolated.new_trade(params)
+        ```
         """
         if config is None:
             config = APIClientConfig()