oxarchive 0.3.5__tar.gz → 0.4.1__tar.gz

{oxarchive-0.3.5 → oxarchive-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oxarchive
-Version: 0.3.5
+Version: 0.4.1
 Summary: Official Python SDK for 0xarchive - Hyperliquid Historical Data API
 Project-URL: Homepage, https://0xarchive.io
 Project-URL: Documentation, https://0xarchive.io/docs/sdks
@@ -24,7 +24,7 @@ Requires-Python: >=3.9
 Requires-Dist: httpx>=0.25.0
 Requires-Dist: pydantic>=2.0.0
 Provides-Extra: all
-Requires-Dist: websockets>=12.0; extra == 'all'
+Requires-Dist: websockets>=14.0; extra == 'all'
 Provides-Extra: dev
 Requires-Dist: mypy>=1.9.0; extra == 'dev'
 Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
@@ -32,12 +32,16 @@ Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
 Requires-Dist: pytest>=8.0.0; extra == 'dev'
 Requires-Dist: ruff>=0.4.0; extra == 'dev'
 Provides-Extra: websocket
-Requires-Dist: websockets>=12.0; extra == 'websocket'
+Requires-Dist: websockets>=14.0; extra == 'websocket'
 Description-Content-Type: text/markdown
 
 # oxarchive
 
-Official Python SDK for [0xarchive](https://0xarchive.io) - Hyperliquid Historical Data API.
+Official Python SDK for [0xarchive](https://0xarchive.io) - Historical Market Data API.
+
+Supports multiple exchanges:
+- **Hyperliquid** - Perpetuals data from April 2023
+- **Lighter.xyz** - Perpetuals data (August 2025+ for fills, Jan 2026+ for OB, OI, Funding Rate)
 
 ## Installation
 
@@ -58,12 +62,16 @@ from oxarchive import Client
 
 client = Client(api_key="ox_your_api_key")
 
-# Get current order book
-orderbook = client.orderbook.get("BTC")
-print(f"BTC mid price: {orderbook.mid_price}")
+# Hyperliquid data
+hl_orderbook = client.hyperliquid.orderbook.get("BTC")
+print(f"Hyperliquid BTC mid price: {hl_orderbook.mid_price}")
+
+# Lighter.xyz data
+lighter_orderbook = client.lighter.orderbook.get("BTC")
+print(f"Lighter BTC mid price: {lighter_orderbook.mid_price}")
 
 # Get historical order book snapshots
-history = client.orderbook.history(
+history = client.hyperliquid.orderbook.history(
     "ETH",
     start="2024-01-01",
     end="2024-01-02",
@@ -82,10 +90,13 @@ from oxarchive import Client
 async def main():
     client = Client(api_key="ox_your_api_key")
 
-    # Async get
-    orderbook = await client.orderbook.aget("BTC")
+    # Async get (Hyperliquid)
+    orderbook = await client.hyperliquid.orderbook.aget("BTC")
     print(f"BTC mid price: {orderbook.mid_price}")
 
+    # Async get (Lighter.xyz)
+    lighter_ob = await client.lighter.orderbook.aget("BTC")
+
     # Don't forget to close the client
     await client.aclose()
 
@@ -96,7 +107,7 @@ Or use as async context manager:
 
 ```python
 async with Client(api_key="ox_your_api_key") as client:
-    orderbook = await client.orderbook.aget("BTC")
+    orderbook = await client.hyperliquid.orderbook.aget("BTC")
 ```
 
 ## Configuration
@@ -111,20 +122,25 @@ client = Client(
 
 ## REST API Reference
 
+All examples use `client.hyperliquid.*` but the same methods are available on `client.lighter.*` for Lighter.xyz data.
+
 ### Order Book
 
 ```python
-# Get current order book
-orderbook = client.orderbook.get("BTC")
+# Get current order book (Hyperliquid)
+orderbook = client.hyperliquid.orderbook.get("BTC")
+
+# Get current order book (Lighter.xyz)
+orderbook = client.lighter.orderbook.get("BTC")
 
 # Get order book at specific timestamp
-historical = client.orderbook.get("BTC", timestamp=1704067200000)
+historical = client.hyperliquid.orderbook.get("BTC", timestamp=1704067200000)
 
 # Get with limited depth
-shallow = client.orderbook.get("BTC", depth=10)
+shallow = client.hyperliquid.orderbook.get("BTC", depth=10)
 
 # Get historical snapshots (start and end are required)
-history = client.orderbook.history(
+history = client.hyperliquid.orderbook.history(
     "BTC",
     start="2024-01-01",
     end="2024-01-02",
@@ -133,8 +149,8 @@ history = client.orderbook.history(
 )
 
 # Async versions
-orderbook = await client.orderbook.aget("BTC")
-history = await client.orderbook.ahistory("BTC", start=..., end=...)
+orderbook = await client.hyperliquid.orderbook.aget("BTC")
+history = await client.hyperliquid.orderbook.ahistory("BTC", start=..., end=...)
 ```
 
 ### Trades
@@ -143,15 +159,15 @@ The trades API uses cursor-based pagination for efficient retrieval of large dat
 
 ```python
 # Get recent trades
-recent = client.trades.recent("BTC", limit=100)
+recent = client.hyperliquid.trades.recent("BTC", limit=100)
 
 # Get trade history with cursor-based pagination
-result = client.trades.list("ETH", start="2024-01-01", end="2024-01-02", limit=1000)
+result = client.hyperliquid.trades.list("ETH", start="2024-01-01", end="2024-01-02", limit=1000)
 trades = result.data
 
 # Paginate through all results
 while result.next_cursor:
-    result = client.trades.list(
+    result = client.hyperliquid.trades.list(
         "ETH",
         start="2024-01-01",
         end="2024-01-02",
@@ -161,61 +177,73 @@ while result.next_cursor:
     trades.extend(result.data)
 
 # Filter by side
-buys = client.trades.list("BTC", start=..., end=..., side="buy")
+buys = client.hyperliquid.trades.list("BTC", start=..., end=..., side="buy")
 
 # Async versions
-recent = await client.trades.arecent("BTC")
-result = await client.trades.alist("ETH", start=..., end=...)
+recent = await client.hyperliquid.trades.arecent("BTC")
+result = await client.hyperliquid.trades.alist("ETH", start=..., end=...)
 ```
 
 ### Instruments
 
 ```python
 # List all trading instruments
-instruments = client.instruments.list()
+instruments = client.hyperliquid.instruments.list()
 
 # Get specific instrument details
-btc = client.instruments.get("BTC")
+btc = client.hyperliquid.instruments.get("BTC")
 
 # Async versions
-instruments = await client.instruments.alist()
-btc = await client.instruments.aget("BTC")
+instruments = await client.hyperliquid.instruments.alist()
+btc = await client.hyperliquid.instruments.aget("BTC")
 ```
 
 ### Funding Rates
 
 ```python
 # Get current funding rate
-current = client.funding.current("BTC")
+current = client.hyperliquid.funding.current("BTC")
 
 # Get funding rate history (start is required)
-history = client.funding.history(
+history = client.hyperliquid.funding.history(
     "ETH",
     start="2024-01-01",
     end="2024-01-07"
 )
 
 # Async versions
-current = await client.funding.acurrent("BTC")
-history = await client.funding.ahistory("ETH", start=..., end=...)
+current = await client.hyperliquid.funding.acurrent("BTC")
+history = await client.hyperliquid.funding.ahistory("ETH", start=..., end=...)
 ```
 
 ### Open Interest
 
 ```python
 # Get current open interest
-current = client.open_interest.current("BTC")
+current = client.hyperliquid.open_interest.current("BTC")
 
 # Get open interest history (start is required)
-history = client.open_interest.history(
+history = client.hyperliquid.open_interest.history(
     "ETH",
     start="2024-01-01",
     end="2024-01-07"
 )
 
 # Async versions
-current = await client.open_interest.acurrent("BTC")
-history = await client.open_interest.ahistory("ETH", start=..., end=...)
+current = await client.hyperliquid.open_interest.acurrent("BTC")
+history = await client.hyperliquid.open_interest.ahistory("ETH", start=..., end=...)
+```
+
+### Legacy API (Deprecated)
+
+The following legacy methods are deprecated and will be removed in v2.0. They default to Hyperliquid data:
+
+```python
+# Deprecated - use client.hyperliquid.orderbook.get() instead
+orderbook = client.orderbook.get("BTC")
+
+# Deprecated - use client.hyperliquid.trades.list() instead
+trades = client.trades.list("BTC", start=..., end=...)
 ```
 
 ## WebSocket Client

{oxarchive-0.3.5 → oxarchive-0.4.1}/README.md

@@ -1,6 +1,10 @@
 # oxarchive
 
-Official Python SDK for [0xarchive](https://0xarchive.io) - Hyperliquid Historical Data API.
+Official Python SDK for [0xarchive](https://0xarchive.io) - Historical Market Data API.
+
+Supports multiple exchanges:
+- **Hyperliquid** - Perpetuals data from April 2023
+- **Lighter.xyz** - Perpetuals data (August 2025+ for fills, Jan 2026+ for OB, OI, Funding Rate)
 
 ## Installation
 
@@ -21,12 +25,16 @@ from oxarchive import Client
 
 client = Client(api_key="ox_your_api_key")
 
-# Get current order book
-orderbook = client.orderbook.get("BTC")
-print(f"BTC mid price: {orderbook.mid_price}")
+# Hyperliquid data
+hl_orderbook = client.hyperliquid.orderbook.get("BTC")
+print(f"Hyperliquid BTC mid price: {hl_orderbook.mid_price}")
+
+# Lighter.xyz data
+lighter_orderbook = client.lighter.orderbook.get("BTC")
+print(f"Lighter BTC mid price: {lighter_orderbook.mid_price}")
 
 # Get historical order book snapshots
-history = client.orderbook.history(
+history = client.hyperliquid.orderbook.history(
     "ETH",
     start="2024-01-01",
     end="2024-01-02",
@@ -45,10 +53,13 @@ from oxarchive import Client
 async def main():
     client = Client(api_key="ox_your_api_key")
 
-    # Async get
-    orderbook = await client.orderbook.aget("BTC")
+    # Async get (Hyperliquid)
+    orderbook = await client.hyperliquid.orderbook.aget("BTC")
     print(f"BTC mid price: {orderbook.mid_price}")
 
+    # Async get (Lighter.xyz)
+    lighter_ob = await client.lighter.orderbook.aget("BTC")
+
     # Don't forget to close the client
     await client.aclose()
 
@@ -59,7 +70,7 @@ Or use as async context manager:
 
 ```python
 async with Client(api_key="ox_your_api_key") as client:
-    orderbook = await client.orderbook.aget("BTC")
+    orderbook = await client.hyperliquid.orderbook.aget("BTC")
 ```
 
 ## Configuration
@@ -74,20 +85,25 @@ client = Client(
 
 ## REST API Reference
 
+All examples use `client.hyperliquid.*` but the same methods are available on `client.lighter.*` for Lighter.xyz data.
+
 ### Order Book
 
 ```python
-# Get current order book
-orderbook = client.orderbook.get("BTC")
+# Get current order book (Hyperliquid)
+orderbook = client.hyperliquid.orderbook.get("BTC")
+
+# Get current order book (Lighter.xyz)
+orderbook = client.lighter.orderbook.get("BTC")
 
 # Get order book at specific timestamp
-historical = client.orderbook.get("BTC", timestamp=1704067200000)
+historical = client.hyperliquid.orderbook.get("BTC", timestamp=1704067200000)
 
 # Get with limited depth
-shallow = client.orderbook.get("BTC", depth=10)
+shallow = client.hyperliquid.orderbook.get("BTC", depth=10)
 
 # Get historical snapshots (start and end are required)
-history = client.orderbook.history(
+history = client.hyperliquid.orderbook.history(
     "BTC",
     start="2024-01-01",
     end="2024-01-02",
@@ -96,8 +112,8 @@ history = client.orderbook.history(
 )
 
 # Async versions
-orderbook = await client.orderbook.aget("BTC")
-history = await client.orderbook.ahistory("BTC", start=..., end=...)
+orderbook = await client.hyperliquid.orderbook.aget("BTC")
+history = await client.hyperliquid.orderbook.ahistory("BTC", start=..., end=...)
 ```
 
 ### Trades
@@ -106,15 +122,15 @@ The trades API uses cursor-based pagination for efficient retrieval of large dat
 
 ```python
 # Get recent trades
-recent = client.trades.recent("BTC", limit=100)
+recent = client.hyperliquid.trades.recent("BTC", limit=100)
 
 # Get trade history with cursor-based pagination
-result = client.trades.list("ETH", start="2024-01-01", end="2024-01-02", limit=1000)
+result = client.hyperliquid.trades.list("ETH", start="2024-01-01", end="2024-01-02", limit=1000)
 trades = result.data
 
 # Paginate through all results
 while result.next_cursor:
-    result = client.trades.list(
+    result = client.hyperliquid.trades.list(
         "ETH",
         start="2024-01-01",
         end="2024-01-02",
@@ -124,61 +140,73 @@ while result.next_cursor:
     trades.extend(result.data)
 
 # Filter by side
-buys = client.trades.list("BTC", start=..., end=..., side="buy")
+buys = client.hyperliquid.trades.list("BTC", start=..., end=..., side="buy")
 
 # Async versions
-recent = await client.trades.arecent("BTC")
-result = await client.trades.alist("ETH", start=..., end=...)
+recent = await client.hyperliquid.trades.arecent("BTC")
+result = await client.hyperliquid.trades.alist("ETH", start=..., end=...)
 ```
 
 ### Instruments
 
 ```python
 # List all trading instruments
-instruments = client.instruments.list()
+instruments = client.hyperliquid.instruments.list()
 
 # Get specific instrument details
-btc = client.instruments.get("BTC")
+btc = client.hyperliquid.instruments.get("BTC")
 
 # Async versions
-instruments = await client.instruments.alist()
-btc = await client.instruments.aget("BTC")
+instruments = await client.hyperliquid.instruments.alist()
+btc = await client.hyperliquid.instruments.aget("BTC")
 ```
 
 ### Funding Rates
 
 ```python
 # Get current funding rate
-current = client.funding.current("BTC")
+current = client.hyperliquid.funding.current("BTC")
 
 # Get funding rate history (start is required)
-history = client.funding.history(
+history = client.hyperliquid.funding.history(
     "ETH",
     start="2024-01-01",
     end="2024-01-07"
 )
 
 # Async versions
-current = await client.funding.acurrent("BTC")
-history = await client.funding.ahistory("ETH", start=..., end=...)
+current = await client.hyperliquid.funding.acurrent("BTC")
+history = await client.hyperliquid.funding.ahistory("ETH", start=..., end=...)
 ```
 
 ### Open Interest
 
 ```python
 # Get current open interest
-current = client.open_interest.current("BTC")
+current = client.hyperliquid.open_interest.current("BTC")
 
 # Get open interest history (start is required)
-history = client.open_interest.history(
+history = client.hyperliquid.open_interest.history(
     "ETH",
     start="2024-01-01",
     end="2024-01-07"
 )
 
 # Async versions
-current = await client.open_interest.acurrent("BTC")
-history = await client.open_interest.ahistory("ETH", start=..., end=...)
+current = await client.hyperliquid.open_interest.acurrent("BTC")
+history = await client.hyperliquid.open_interest.ahistory("ETH", start=..., end=...)
+```
+
+### Legacy API (Deprecated)
+
+The following legacy methods are deprecated and will be removed in v2.0. They default to Hyperliquid data:
+
+```python
+# Deprecated - use client.hyperliquid.orderbook.get() instead
+orderbook = client.orderbook.get("BTC")
+
+# Deprecated - use client.hyperliquid.trades.list() instead
+trades = client.trades.list("BTC", start=..., end=...)
 ```
 
 ## WebSocket Client

{oxarchive-0.3.5 → oxarchive-0.4.1}/oxarchive/__init__.py

@@ -1,22 +1,28 @@
 """
 oxarchive - Official Python SDK for 0xarchive
 
-Hyperliquid Historical Data API.
+Historical Market Data API for multiple exchanges:
+- Hyperliquid (perpetuals data from April 2023)
+- Lighter.xyz (perpetuals data)
 
 Example:
     >>> from oxarchive import Client
     >>>
     >>> client = Client(api_key="ox_your_api_key")
     >>>
-    >>> # Get current order book
-    >>> orderbook = client.orderbook.get("BTC")
-    >>> print(f"BTC mid price: {orderbook.mid_price}")
+    >>> # Hyperliquid data
+    >>> hl_orderbook = client.hyperliquid.orderbook.get("BTC")
+    >>> print(f"BTC mid price: {hl_orderbook.mid_price}")
+    >>>
+    >>> # Lighter.xyz data
+    >>> lighter_orderbook = client.lighter.orderbook.get("BTC")
     >>>
     >>> # Get historical snapshots
-    >>> history = client.orderbook.history("ETH", start="2024-01-01", end="2024-01-02")
+    >>> history = client.hyperliquid.orderbook.history("ETH", start="2024-01-01", end="2024-01-02")
 """
 
 from .client import Client
+from .exchanges import HyperliquidClient, LighterClient
 from .types import (
     OrderBook,
     Trade,
@@ -57,11 +63,14 @@ except ImportError:
     OxArchiveWs = None  # type: ignore
     WsOptions = None  # type: ignore
 
-__version__ = "0.3.5"
+__version__ = "0.4.1"
 
 __all__ = [
     # Client
     "Client",
+    # Exchange Clients
+    "HyperliquidClient",
+    "LighterClient",
     # WebSocket Client
     "OxArchiveWs",
     "WsOptions",

oxarchive-0.4.1/oxarchive/client.py

@@ -0,0 +1,132 @@
+"""0xarchive API client."""
+
+from __future__ import annotations
+
+from typing import Optional
+
+from .http import HttpClient
+from .exchanges import HyperliquidClient, LighterClient
+from .resources import (
+    OrderBookResource,
+    TradesResource,
+    InstrumentsResource,
+    FundingResource,
+    OpenInterestResource,
+)
+
+DEFAULT_BASE_URL = "https://api.0xarchive.io"
+DEFAULT_TIMEOUT = 30.0
+
+
+class Client:
+    """
+    0xarchive API client.
+
+    Supports multiple exchanges:
+    - `client.hyperliquid` - Hyperliquid perpetuals (April 2023+)
+    - `client.lighter` - Lighter.xyz perpetuals
+
+    Example:
+        >>> from oxarchive import Client
+        >>>
+        >>> client = Client(api_key="ox_your_api_key")
+        >>>
+        >>> # Hyperliquid data
+        >>> hl_orderbook = client.hyperliquid.orderbook.get("BTC")
+        >>> print(f"BTC mid price: {hl_orderbook.mid_price}")
+        >>>
+        >>> # Lighter.xyz data
+        >>> lighter_orderbook = client.lighter.orderbook.get("BTC")
+        >>>
+        >>> # Get historical snapshots
+        >>> history = client.hyperliquid.orderbook.history("ETH", start="2024-01-01", end="2024-01-02")
+        >>>
+        >>> # List all instruments
+        >>> instruments = client.hyperliquid.instruments.list()
+
+    Async example:
+        >>> import asyncio
+        >>> from oxarchive import Client
+        >>>
+        >>> async def main():
+        ...     client = Client(api_key="ox_your_api_key")
+        ...     orderbook = await client.hyperliquid.orderbook.aget("BTC")
+        ...     print(f"BTC mid price: {orderbook.mid_price}")
+        ...     await client.aclose()
+        >>>
+        >>> asyncio.run(main())
+
+    Legacy usage (deprecated, will be removed in v2.0):
+        >>> # These still work but use client.hyperliquid.* instead
+        >>> orderbook = client.orderbook.get("BTC")  # deprecated
+    """
+
+    def __init__(
+        self,
+        api_key: str,
+        *,
+        base_url: Optional[str] = None,
+        timeout: Optional[float] = None,
+    ):
+        """
+        Create a new 0xarchive client.
+
+        Args:
+            api_key: Your 0xarchive API key
+            base_url: Base URL for the API (defaults to https://api.0xarchive.io)
+            timeout: Request timeout in seconds (defaults to 30.0)
+        """
+        if not api_key:
+            raise ValueError("API key is required. Get one at https://0xarchive.io/signup")
+
+        self._http = HttpClient(
+            base_url=base_url or DEFAULT_BASE_URL,
+            api_key=api_key,
+            timeout=timeout or DEFAULT_TIMEOUT,
+        )
+
+        # Exchange-specific clients (recommended)
+        self.hyperliquid = HyperliquidClient(self._http)
+        """Hyperliquid exchange data (orderbook, trades, funding, OI from April 2023)"""
+
+        self.lighter = LighterClient(self._http)
+        """Lighter.xyz exchange data (August 2025+)"""
+
+        # Legacy resource namespaces (deprecated - use client.hyperliquid.* instead)
+        # These will be removed in v2.0
+        # Note: Using /v1/hyperliquid base path for backward compatibility
+        legacy_base = "/v1/hyperliquid"
+        self.orderbook = OrderBookResource(self._http, legacy_base)
+        """[DEPRECATED] Use client.hyperliquid.orderbook instead"""
+
+        self.trades = TradesResource(self._http, legacy_base)
+        """[DEPRECATED] Use client.hyperliquid.trades instead"""
+
+        self.instruments = InstrumentsResource(self._http, legacy_base)
+        """[DEPRECATED] Use client.hyperliquid.instruments instead"""
+
+        self.funding = FundingResource(self._http, legacy_base)
+        """[DEPRECATED] Use client.hyperliquid.funding instead"""
+
+        self.open_interest = OpenInterestResource(self._http, legacy_base)
+        """[DEPRECATED] Use client.hyperliquid.open_interest instead"""
+
+    def close(self) -> None:
+        """Close the HTTP client and release resources."""
+        self._http.close()
+
+    async def aclose(self) -> None:
+        """Close the async HTTP client and release resources."""
+        await self._http.aclose()
+
+    def __enter__(self) -> "Client":
+        return self
+
+    def __exit__(self, *args) -> None:
+        self.close()
+
+    async def __aenter__(self) -> "Client":
+        return self
+
+    async def __aexit__(self, *args) -> None:
+        await self.aclose()

oxarchive-0.4.1/oxarchive/exchanges.py

@@ -0,0 +1,76 @@
+"""Exchange-specific client classes."""
+
+from __future__ import annotations
+
+from .http import HttpClient
+from .resources import (
+    OrderBookResource,
+    TradesResource,
+    InstrumentsResource,
+    FundingResource,
+    OpenInterestResource,
+)
+
+
+class HyperliquidClient:
+    """
+    Hyperliquid exchange client.
+
+    Access Hyperliquid market data through the 0xarchive API.
+
+    Example:
+        >>> client = oxarchive.Client(api_key="...")
+        >>> orderbook = client.hyperliquid.orderbook.get("BTC")
+        >>> trades = client.hyperliquid.trades.list("ETH", start=..., end=...)
+    """
+
+    def __init__(self, http: HttpClient):
+        self._http = http
+        base_path = "/v1/hyperliquid"
+
+        self.orderbook = OrderBookResource(http, base_path)
+        """Order book data (L2 snapshots from April 2023)"""
+
+        self.trades = TradesResource(http, base_path)
+        """Trade/fill history"""
+
+        self.instruments = InstrumentsResource(http, base_path)
+        """Trading instruments metadata"""
+
+        self.funding = FundingResource(http, base_path)
+        """Funding rates"""
+
+        self.open_interest = OpenInterestResource(http, base_path)
+        """Open interest"""
+
+
+class LighterClient:
+    """
+    Lighter.xyz exchange client.
+
+    Access Lighter.xyz market data through the 0xarchive API.
+
+    Example:
+        >>> client = oxarchive.Client(api_key="...")
+        >>> orderbook = client.lighter.orderbook.get("BTC")
+        >>> trades = client.lighter.trades.list("ETH", start=..., end=...)
+    """
+
+    def __init__(self, http: HttpClient):
+        self._http = http
+        base_path = "/v1/lighter"
+
+        self.orderbook = OrderBookResource(http, base_path)
+        """Order book data (L2 snapshots)"""
+
+        self.trades = TradesResource(http, base_path)
+        """Trade/fill history"""
+
+        self.instruments = InstrumentsResource(http, base_path)
+        """Trading instruments metadata"""
+
+        self.funding = FundingResource(http, base_path)
+        """Funding rates"""
+
+        self.open_interest = OpenInterestResource(http, base_path)
+        """Open interest"""