oxarchive 0.5.2__tar.gz → 0.5.4__tar.gz

{oxarchive-0.5.2 → oxarchive-0.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oxarchive
-Version: 0.5.2
+Version: 0.5.4
 Summary: Official Python SDK for 0xarchive - Hyperliquid Historical Data API
 Project-URL: Homepage, https://0xarchive.io
 Project-URL: Documentation, https://0xarchive.io/docs/sdks
@@ -211,9 +211,6 @@ history = client.lighter.orderbook.history(
 The trades API uses cursor-based pagination for efficient retrieval of large datasets.
 
 ```python
-# Get recent trades
-recent = client.hyperliquid.trades.recent("BTC", limit=100)
-
 # Get trade history with cursor-based pagination
 result = client.hyperliquid.trades.list("ETH", start="2024-01-01", end="2024-01-02", limit=1000)
 trades = result.data
@@ -232,9 +229,12 @@ while result.next_cursor:
 # Filter by side
 buys = client.hyperliquid.trades.list("BTC", start=..., end=..., side="buy")
 
+# Get recent trades (Lighter only - has real-time data)
+recent = client.lighter.trades.recent("BTC", limit=100)
+
 # Async versions
-recent = await client.hyperliquid.trades.arecent("BTC")
 result = await client.hyperliquid.trades.alist("ETH", start=..., end=...)
+recent = await client.lighter.trades.arecent("BTC", limit=100)
 ```
 
 ### Instruments
@@ -317,6 +317,44 @@ current = await client.hyperliquid.open_interest.acurrent("BTC")
 history = await client.hyperliquid.open_interest.ahistory("ETH", start=..., end=...)
 ```
 
+### Liquidations (Hyperliquid only)
+
+Get historical liquidation events. Data available from May 2025 onwards.
+
+```python
+# Get liquidation history for a coin
+liquidations = client.hyperliquid.liquidations.history(
+    "BTC",
+    start="2025-06-01",
+    end="2025-06-02",
+    limit=100
+)
+
+# Paginate through all results
+all_liquidations = list(liquidations.data)
+while liquidations.next_cursor:
+    liquidations = client.hyperliquid.liquidations.history(
+        "BTC",
+        start="2025-06-01",
+        end="2025-06-02",
+        cursor=liquidations.next_cursor,
+        limit=1000
+    )
+    all_liquidations.extend(liquidations.data)
+
+# Get liquidations for a specific user
+user_liquidations = client.hyperliquid.liquidations.by_user(
+    "0x1234...",
+    start="2025-06-01",
+    end="2025-06-07",
+    coin="BTC"  # optional filter
+)
+
+# Async versions
+liquidations = await client.hyperliquid.liquidations.ahistory("BTC", start=..., end=...)
+user_liquidations = await client.hyperliquid.liquidations.aby_user("0x...", start=..., end=...)
+```
+
 ### Candles (OHLCV)
 
 Get historical OHLCV candle data aggregated from trades.
@@ -636,14 +674,16 @@ Full type hint support with Pydantic models:
 
 ```python
 from oxarchive import Client, LighterGranularity
-from oxarchive.types import OrderBook, Trade, Instrument, LighterInstrument, FundingRate, OpenInterest
+from oxarchive.types import OrderBook, Trade, Instrument, LighterInstrument, FundingRate, OpenInterest, Candle, Liquidation
 from oxarchive.resources.trades import CursorResponse
 
 client = Client(api_key="ox_your_api_key")
 
-orderbook: OrderBook = client.orderbook.get("BTC")
-trades: list[Trade] = client.trades.recent("BTC")
-result: CursorResponse = client.trades.list("BTC", start=..., end=...)
+orderbook: OrderBook = client.hyperliquid.orderbook.get("BTC")
+result: CursorResponse = client.hyperliquid.trades.list("BTC", start=..., end=...)
+
+# Lighter has real-time data, so recent() is available
+recent: list[Trade] = client.lighter.trades.recent("BTC")
 
 # Lighter granularity type hint
 granularity: LighterGranularity = "10s"

{oxarchive-0.5.2 → oxarchive-0.5.4}/README.md

@@ -174,9 +174,6 @@ history = client.lighter.orderbook.history(
 The trades API uses cursor-based pagination for efficient retrieval of large datasets.
 
 ```python
-# Get recent trades
-recent = client.hyperliquid.trades.recent("BTC", limit=100)
-
 # Get trade history with cursor-based pagination
 result = client.hyperliquid.trades.list("ETH", start="2024-01-01", end="2024-01-02", limit=1000)
 trades = result.data
@@ -195,9 +192,12 @@ while result.next_cursor:
 # Filter by side
 buys = client.hyperliquid.trades.list("BTC", start=..., end=..., side="buy")
 
+# Get recent trades (Lighter only - has real-time data)
+recent = client.lighter.trades.recent("BTC", limit=100)
+
 # Async versions
-recent = await client.hyperliquid.trades.arecent("BTC")
 result = await client.hyperliquid.trades.alist("ETH", start=..., end=...)
+recent = await client.lighter.trades.arecent("BTC", limit=100)
 ```
 
 ### Instruments
@@ -280,6 +280,44 @@ current = await client.hyperliquid.open_interest.acurrent("BTC")
 history = await client.hyperliquid.open_interest.ahistory("ETH", start=..., end=...)
 ```
 
+### Liquidations (Hyperliquid only)
+
+Get historical liquidation events. Data available from May 2025 onwards.
+
+```python
+# Get liquidation history for a coin
+liquidations = client.hyperliquid.liquidations.history(
+    "BTC",
+    start="2025-06-01",
+    end="2025-06-02",
+    limit=100
+)
+
+# Paginate through all results
+all_liquidations = list(liquidations.data)
+while liquidations.next_cursor:
+    liquidations = client.hyperliquid.liquidations.history(
+        "BTC",
+        start="2025-06-01",
+        end="2025-06-02",
+        cursor=liquidations.next_cursor,
+        limit=1000
+    )
+    all_liquidations.extend(liquidations.data)
+
+# Get liquidations for a specific user
+user_liquidations = client.hyperliquid.liquidations.by_user(
+    "0x1234...",
+    start="2025-06-01",
+    end="2025-06-07",
+    coin="BTC"  # optional filter
+)
+
+# Async versions
+liquidations = await client.hyperliquid.liquidations.ahistory("BTC", start=..., end=...)
+user_liquidations = await client.hyperliquid.liquidations.aby_user("0x...", start=..., end=...)
+```
+
 ### Candles (OHLCV)
 
 Get historical OHLCV candle data aggregated from trades.
@@ -599,14 +637,16 @@ Full type hint support with Pydantic models:
 
 ```python
 from oxarchive import Client, LighterGranularity
-from oxarchive.types import OrderBook, Trade, Instrument, LighterInstrument, FundingRate, OpenInterest
+from oxarchive.types import OrderBook, Trade, Instrument, LighterInstrument, FundingRate, OpenInterest, Candle, Liquidation
 from oxarchive.resources.trades import CursorResponse
 
 client = Client(api_key="ox_your_api_key")
 
-orderbook: OrderBook = client.orderbook.get("BTC")
-trades: list[Trade] = client.trades.recent("BTC")
-result: CursorResponse = client.trades.list("BTC", start=..., end=...)
+orderbook: OrderBook = client.hyperliquid.orderbook.get("BTC")
+result: CursorResponse = client.hyperliquid.trades.list("BTC", start=..., end=...)
+
+# Lighter has real-time data, so recent() is available
+recent: list[Trade] = client.lighter.trades.recent("BTC")
 
 # Lighter granularity type hint
 granularity: LighterGranularity = "10s"

{oxarchive-0.5.2 → oxarchive-0.5.4}/oxarchive/__init__.py

@@ -31,6 +31,7 @@ from .types import (
     LighterInstrument,
     FundingRate,
     OpenInterest,
+    Liquidation,
     Candle,
     CandleInterval,
     OxArchiveError,
@@ -67,7 +68,7 @@ except ImportError:
     OxArchiveWs = None  # type: ignore
     WsOptions = None  # type: ignore
 
-__version__ = "0.5.2"
+__version__ = "0.5.4"
 
 __all__ = [
     # Client
@@ -86,6 +87,7 @@ __all__ = [
     "LighterGranularity",
     "FundingRate",
     "OpenInterest",
+    "Liquidation",
     "Candle",
     "CandleInterval",
     "OxArchiveError",

{oxarchive-0.5.2 → oxarchive-0.5.4}/oxarchive/resources/trades.py

@@ -14,17 +14,17 @@ class TradesResource:
     Trades API resource.
 
     Example:
-        >>> # Get recent trades
-        >>> trades = client.trades.recent("BTC")
-        >>>
         >>> # Get trade history with cursor-based pagination (recommended)
-        >>> result = client.trades.list("BTC", start="2024-01-01", end="2024-01-02")
+        >>> result = client.hyperliquid.trades.list("BTC", start="2024-01-01", end="2024-01-02")
         >>> trades = result.data
         >>>
         >>> # Get all pages
         >>> while result.next_cursor:
-        ...     result = client.trades.list("BTC", start="2024-01-01", end="2024-01-02", cursor=result.next_cursor)
+        ...     result = client.hyperliquid.trades.list("BTC", start="2024-01-01", end="2024-01-02", cursor=result.next_cursor)
         ...     trades.extend(result.data)
+        >>>
+        >>> # Get recent trades (Lighter only - has real-time data)
+        >>> recent = client.lighter.trades.recent("BTC")
     """
 
     def __init__(self, http: HttpClient, base_path: str = "/v1"):
@@ -135,6 +135,10 @@ class TradesResource:
         """
         Get most recent trades for a coin.
 
+        Note: This method is only available for Lighter (client.lighter.trades.recent())
+        which has real-time data ingestion. Hyperliquid uses hourly backfill so this
+        endpoint is not available for Hyperliquid.
+
         Args:
             coin: The coin symbol (e.g., 'BTC', 'ETH')
             limit: Number of trades to return (default: 100)

{oxarchive-0.5.2 → oxarchive-0.5.4}/pyproject.toml

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