oxarchive 0.4.0__tar.gz → 0.4.2__tar.gz

{oxarchive-0.4.0 → oxarchive-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oxarchive
-Version: 0.4.0
+Version: 0.4.2
 Summary: Official Python SDK for 0xarchive - Hyperliquid Historical Data API
 Project-URL: Homepage, https://0xarchive.io
 Project-URL: Documentation, https://0xarchive.io/docs/sdks
@@ -41,7 +41,7 @@ Official Python SDK for [0xarchive](https://0xarchive.io) - Historical Market Da
 
 Supports multiple exchanges:
 - **Hyperliquid** - Perpetuals data from April 2023
-- **Lighter.xyz** - Perpetuals data with orderbook reconstruction
+- **Lighter.xyz** - Perpetuals data (August 2025+ for fills, Jan 2026+ for OB, OI, Funding Rate)
 
 ## Installation
 
@@ -187,17 +187,47 @@ result = await client.hyperliquid.trades.alist("ETH", start=..., end=...)
 ### Instruments
 
 ```python
-# List all trading instruments
+# List all trading instruments (Hyperliquid)
 instruments = client.hyperliquid.instruments.list()
 
 # Get specific instrument details
 btc = client.hyperliquid.instruments.get("BTC")
+print(f"BTC size decimals: {btc.sz_decimals}")
 
 # Async versions
 instruments = await client.hyperliquid.instruments.alist()
 btc = await client.hyperliquid.instruments.aget("BTC")
 ```
 
+#### Lighter.xyz Instruments
+
+Lighter instruments have a different schema with additional fields for fees, market IDs, and minimum order amounts:
+
+```python
+# List Lighter instruments (returns LighterInstrument, not Instrument)
+lighter_instruments = client.lighter.instruments.list()
+
+# Get specific Lighter instrument
+eth = client.lighter.instruments.get("ETH")
+print(f"ETH taker fee: {eth.taker_fee}")
+print(f"ETH maker fee: {eth.maker_fee}")
+print(f"ETH market ID: {eth.market_id}")
+print(f"ETH min base amount: {eth.min_base_amount}")
+
+# Async versions
+lighter_instruments = await client.lighter.instruments.alist()
+eth = await client.lighter.instruments.aget("ETH")
+```
+
+**Key differences:**
+| Field | Hyperliquid (`Instrument`) | Lighter (`LighterInstrument`) |
+|-------|---------------------------|------------------------------|
+| Symbol | `name` | `symbol` |
+| Size decimals | `sz_decimals` | `size_decimals` |
+| Fee info | Not available | `taker_fee`, `maker_fee`, `liquidation_fee` |
+| Market ID | Not available | `market_id` |
+| Min amounts | Not available | `min_base_amount`, `min_quote_amount` |
+
 ### Funding Rates
 
 ```python
@@ -450,7 +480,7 @@ Full type hint support with Pydantic models:
 
 ```python
 from oxarchive import Client
-from oxarchive.types import OrderBook, Trade, Instrument, FundingRate, OpenInterest
+from oxarchive.types import OrderBook, Trade, Instrument, LighterInstrument, FundingRate, OpenInterest
 from oxarchive.resources.trades import CursorResponse
 
 client = Client(api_key="ox_your_api_key")

{oxarchive-0.4.0 → oxarchive-0.4.2}/README.md

@@ -4,7 +4,7 @@ Official Python SDK for [0xarchive](https://0xarchive.io) - Historical Market Da
 
 Supports multiple exchanges:
 - **Hyperliquid** - Perpetuals data from April 2023
-- **Lighter.xyz** - Perpetuals data with orderbook reconstruction
+- **Lighter.xyz** - Perpetuals data (August 2025+ for fills, Jan 2026+ for OB, OI, Funding Rate)
 
 ## Installation
 
@@ -150,17 +150,47 @@ result = await client.hyperliquid.trades.alist("ETH", start=..., end=...)
 ### Instruments
 
 ```python
-# List all trading instruments
+# List all trading instruments (Hyperliquid)
 instruments = client.hyperliquid.instruments.list()
 
 # Get specific instrument details
 btc = client.hyperliquid.instruments.get("BTC")
+print(f"BTC size decimals: {btc.sz_decimals}")
 
 # Async versions
 instruments = await client.hyperliquid.instruments.alist()
 btc = await client.hyperliquid.instruments.aget("BTC")
 ```
 
+#### Lighter.xyz Instruments
+
+Lighter instruments have a different schema with additional fields for fees, market IDs, and minimum order amounts:
+
+```python
+# List Lighter instruments (returns LighterInstrument, not Instrument)
+lighter_instruments = client.lighter.instruments.list()
+
+# Get specific Lighter instrument
+eth = client.lighter.instruments.get("ETH")
+print(f"ETH taker fee: {eth.taker_fee}")
+print(f"ETH maker fee: {eth.maker_fee}")
+print(f"ETH market ID: {eth.market_id}")
+print(f"ETH min base amount: {eth.min_base_amount}")
+
+# Async versions
+lighter_instruments = await client.lighter.instruments.alist()
+eth = await client.lighter.instruments.aget("ETH")
+```
+
+**Key differences:**
+| Field | Hyperliquid (`Instrument`) | Lighter (`LighterInstrument`) |
+|-------|---------------------------|------------------------------|
+| Symbol | `name` | `symbol` |
+| Size decimals | `sz_decimals` | `size_decimals` |
+| Fee info | Not available | `taker_fee`, `maker_fee`, `liquidation_fee` |
+| Market ID | Not available | `market_id` |
+| Min amounts | Not available | `min_base_amount`, `min_quote_amount` |
+
 ### Funding Rates
 
 ```python
@@ -413,7 +443,7 @@ Full type hint support with Pydantic models:
 
 ```python
 from oxarchive import Client
-from oxarchive.types import OrderBook, Trade, Instrument, FundingRate, OpenInterest
+from oxarchive.types import OrderBook, Trade, Instrument, LighterInstrument, FundingRate, OpenInterest
 from oxarchive.resources.trades import CursorResponse
 
 client = Client(api_key="ox_your_api_key")

{oxarchive-0.4.0 → oxarchive-0.4.2}/oxarchive/__init__.py

@@ -27,6 +27,7 @@ from .types import (
     OrderBook,
     Trade,
     Instrument,
+    LighterInstrument,
     FundingRate,
     OpenInterest,
     OxArchiveError,
@@ -63,7 +64,7 @@ except ImportError:
     OxArchiveWs = None  # type: ignore
     WsOptions = None  # type: ignore
 
-__version__ = "0.4.0"
+__version__ = "0.4.2"
 
 __all__ = [
     # Client
@@ -78,6 +79,7 @@ __all__ = [
     "OrderBook",
     "Trade",
     "Instrument",
+    "LighterInstrument",
     "FundingRate",
     "OpenInterest",
     "OxArchiveError",

{oxarchive-0.4.0 → oxarchive-0.4.2}/oxarchive/client.py

@@ -90,7 +90,7 @@ class Client:
         """Hyperliquid exchange data (orderbook, trades, funding, OI from April 2023)"""
 
         self.lighter = LighterClient(self._http)
-        """Lighter.xyz exchange data (orderbook reconstructed from checkpoints + deltas)"""
+        """Lighter.xyz exchange data (August 2025+)"""
 
         # Legacy resource namespaces (deprecated - use client.hyperliquid.* instead)
         # These will be removed in v2.0

{oxarchive-0.4.0 → oxarchive-0.4.2}/oxarchive/exchanges.py

@@ -7,6 +7,7 @@ from .resources import (
     OrderBookResource,
     TradesResource,
     InstrumentsResource,
+    LighterInstrumentsResource,
     FundingResource,
     OpenInterestResource,
 )
@@ -49,12 +50,13 @@ class LighterClient:
     Lighter.xyz exchange client.
 
     Access Lighter.xyz market data through the 0xarchive API.
-    Lighter orderbooks are reconstructed from checkpoint + delta data.
 
     Example:
         >>> client = oxarchive.Client(api_key="...")
         >>> orderbook = client.lighter.orderbook.get("BTC")
         >>> trades = client.lighter.trades.list("ETH", start=..., end=...)
+        >>> instruments = client.lighter.instruments.list()
+        >>> print(f"ETH taker fee: {instruments[0].taker_fee}")
     """
 
     def __init__(self, http: HttpClient):
@@ -62,13 +64,13 @@ class LighterClient:
         base_path = "/v1/lighter"
 
         self.orderbook = OrderBookResource(http, base_path)
-        """Order book data (reconstructed from checkpoints + deltas)"""
+        """Order book data (L2 snapshots)"""
 
         self.trades = TradesResource(http, base_path)
         """Trade/fill history"""
 
-        self.instruments = InstrumentsResource(http, base_path)
-        """Trading instruments metadata"""
+        self.instruments = LighterInstrumentsResource(http, base_path)
+        """Trading instruments metadata (returns LighterInstrument with fees, min amounts, etc.)"""
 
         self.funding = FundingResource(http, base_path)
         """Funding rates"""

{oxarchive-0.4.0 → oxarchive-0.4.2}/oxarchive/resources/__init__.py

@@ -2,7 +2,7 @@
 
 from .orderbook import OrderBookResource
 from .trades import TradesResource
-from .instruments import InstrumentsResource
+from .instruments import InstrumentsResource, LighterInstrumentsResource
 from .funding import FundingResource
 from .openinterest import OpenInterestResource
 
@@ -10,6 +10,7 @@ __all__ = [
     "OrderBookResource",
     "TradesResource",
     "InstrumentsResource",
+    "LighterInstrumentsResource",
     "FundingResource",
     "OpenInterestResource",
 ]

oxarchive-0.4.2/oxarchive/resources/instruments.py

@@ -0,0 +1,110 @@
+"""Instruments API resource."""
+
+from __future__ import annotations
+
+from ..http import HttpClient
+from ..types import Instrument, LighterInstrument
+
+
+class InstrumentsResource:
+    """
+    Instruments API resource.
+
+    Example:
+        >>> # List all instruments
+        >>> instruments = client.instruments.list()
+        >>>
+        >>> # Get specific instrument
+        >>> btc = client.instruments.get("BTC")
+    """
+
+    def __init__(self, http: HttpClient, base_path: str = "/v1"):
+        self._http = http
+        self._base_path = base_path
+
+    def list(self) -> list[Instrument]:
+        """
+        List all available trading instruments.
+
+        Returns:
+            List of instruments
+        """
+        data = self._http.get(f"{self._base_path}/instruments")
+        return [Instrument.model_validate(item) for item in data["data"]]
+
+    async def alist(self) -> list[Instrument]:
+        """Async version of list()."""
+        data = await self._http.aget(f"{self._base_path}/instruments")
+        return [Instrument.model_validate(item) for item in data["data"]]
+
+    def get(self, coin: str) -> Instrument:
+        """
+        Get a specific instrument by coin symbol.
+
+        Args:
+            coin: The coin symbol (e.g., 'BTC', 'ETH')
+
+        Returns:
+            Instrument details
+        """
+        data = self._http.get(f"{self._base_path}/instruments/{coin.upper()}")
+        return Instrument.model_validate(data["data"])
+
+    async def aget(self, coin: str) -> Instrument:
+        """Async version of get()."""
+        data = await self._http.aget(f"{self._base_path}/instruments/{coin.upper()}")
+        return Instrument.model_validate(data["data"])
+
+
+class LighterInstrumentsResource:
+    """
+    Lighter.xyz Instruments API resource.
+
+    Lighter instruments have a different schema than Hyperliquid with more
+    detailed market configuration including fees and minimum amounts.
+
+    Example:
+        >>> # List all Lighter instruments
+        >>> instruments = client.lighter.instruments.list()
+        >>>
+        >>> # Get specific instrument
+        >>> btc = client.lighter.instruments.get("BTC")
+        >>> print(f"Taker fee: {btc.taker_fee}")
+    """
+
+    def __init__(self, http: HttpClient, base_path: str = "/v1/lighter"):
+        self._http = http
+        self._base_path = base_path
+
+    def list(self) -> list[LighterInstrument]:
+        """
+        List all available Lighter trading instruments.
+
+        Returns:
+            List of Lighter instruments with full market configuration
+        """
+        data = self._http.get(f"{self._base_path}/instruments")
+        return [LighterInstrument.model_validate(item) for item in data["data"]]
+
+    async def alist(self) -> list[LighterInstrument]:
+        """Async version of list()."""
+        data = await self._http.aget(f"{self._base_path}/instruments")
+        return [LighterInstrument.model_validate(item) for item in data["data"]]
+
+    def get(self, coin: str) -> LighterInstrument:
+        """
+        Get a specific Lighter instrument by coin symbol.
+
+        Args:
+            coin: The coin symbol (e.g., 'BTC', 'ETH')
+
+        Returns:
+            Lighter instrument details with full market configuration
+        """
+        data = self._http.get(f"{self._base_path}/instruments/{coin.upper()}")
+        return LighterInstrument.model_validate(data["data"])
+
+    async def aget(self, coin: str) -> LighterInstrument:
+        """Async version of get()."""
+        data = await self._http.aget(f"{self._base_path}/instruments/{coin.upper()}")
+        return LighterInstrument.model_validate(data["data"])

{oxarchive-0.4.0 → oxarchive-0.4.2}/oxarchive/types.py

@@ -140,7 +140,7 @@ class Trade(BaseModel):
 
 
 class Instrument(BaseModel):
-    """Trading instrument specification."""
+    """Trading instrument specification (Hyperliquid)."""
 
     model_config = {"populate_by_name": True}
 
@@ -163,6 +163,53 @@ class Instrument(BaseModel):
     """Whether the instrument is currently tradeable."""
 
 
+class LighterInstrument(BaseModel):
+    """Trading instrument specification (Lighter.xyz).
+
+    Lighter instruments have a different schema than Hyperliquid with more
+    detailed market configuration including fees and minimum amounts.
+    """
+
+    symbol: str
+    """Instrument symbol (e.g., BTC, ETH)."""
+
+    market_id: int
+    """Unique market identifier."""
+
+    market_type: str
+    """Market type (e.g., 'perp')."""
+
+    status: str
+    """Market status (e.g., 'active')."""
+
+    taker_fee: float
+    """Taker fee rate (e.g., 0.0005 = 0.05%)."""
+
+    maker_fee: float
+    """Maker fee rate (e.g., 0.0002 = 0.02%)."""
+
+    liquidation_fee: float
+    """Liquidation fee rate."""
+
+    min_base_amount: float
+    """Minimum order size in base currency."""
+
+    min_quote_amount: float
+    """Minimum order size in quote currency."""
+
+    size_decimals: int
+    """Size decimal precision."""
+
+    price_decimals: int
+    """Price decimal precision."""
+
+    quote_decimals: int
+    """Quote currency decimal precision."""
+
+    is_active: bool
+    """Whether the instrument is currently tradeable."""
+
+
 # =============================================================================
 # Funding Types
 # =============================================================================

{oxarchive-0.4.0 → oxarchive-0.4.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "oxarchive"
-version = "0.4.0"
+version = "0.4.2"
 description = "Official Python SDK for 0xarchive - Hyperliquid Historical Data API"
 readme = "README.md"
 license = "MIT"

oxarchive-0.4.0/oxarchive/resources/instruments.py

@@ -1,56 +0,0 @@
-"""Instruments API resource."""
-
-from __future__ import annotations
-
-from ..http import HttpClient
-from ..types import Instrument
-
-
-class InstrumentsResource:
-    """
-    Instruments API resource.
-
-    Example:
-        >>> # List all instruments
-        >>> instruments = client.instruments.list()
-        >>>
-        >>> # Get specific instrument
-        >>> btc = client.instruments.get("BTC")
-    """
-
-    def __init__(self, http: HttpClient, base_path: str = "/v1"):
-        self._http = http
-        self._base_path = base_path
-
-    def list(self) -> list[Instrument]:
-        """
-        List all available trading instruments.
-
-        Returns:
-            List of instruments
-        """
-        data = self._http.get(f"{self._base_path}/instruments")
-        return [Instrument.model_validate(item) for item in data["data"]]
-
-    async def alist(self) -> list[Instrument]:
-        """Async version of list()."""
-        data = await self._http.aget(f"{self._base_path}/instruments")
-        return [Instrument.model_validate(item) for item in data["data"]]
-
-    def get(self, coin: str) -> Instrument:
-        """
-        Get a specific instrument by coin symbol.
-
-        Args:
-            coin: The coin symbol (e.g., 'BTC', 'ETH')
-
-        Returns:
-            Instrument details
-        """
-        data = self._http.get(f"{self._base_path}/instruments/{coin.upper()}")
-        return Instrument.model_validate(data["data"])
-
-    async def aget(self, coin: str) -> Instrument:
-        """Async version of get()."""
-        data = await self._http.aget(f"{self._base_path}/instruments/{coin.upper()}")
-        return Instrument.model_validate(data["data"])