@0xarchive/sdk 0.5.2 → 0.5.4

package/README.md

@@ -132,9 +132,6 @@ const history = await client.lighter.orderbook.history('BTC', {
 The trades API uses cursor-based pagination for efficient retrieval of large datasets.
 
 ```typescript
-// Get recent trades
-const recent = await client.hyperliquid.trades.recent('BTC', 100);
-
 // Get trade history with cursor-based pagination
 let result = await client.hyperliquid.trades.list('BTC', {
   start: Date.now() - 86400000,
@@ -153,6 +150,9 @@ while (result.nextCursor) {
   });
   allTrades.push(...result.data);
 }
+
+// Get recent trades (Lighter only - has real-time data)
+const recent = await client.lighter.trades.recent('BTC', 100);
 ```
 
 ### Instruments
@@ -218,6 +218,38 @@ const history = await client.hyperliquid.openInterest.history('ETH', {
 });
 ```
 
+### Liquidations (Hyperliquid only)
+
+Get historical liquidation events. Data available from May 2025 onwards.
+
+```typescript
+// Get liquidation history for a coin
+const liquidations = await client.hyperliquid.liquidations.history('BTC', {
+  start: Date.now() - 86400000,
+  end: Date.now(),
+  limit: 100
+});
+
+// Paginate through all results
+const allLiquidations = [...liquidations.data];
+while (liquidations.nextCursor) {
+  const next = await client.hyperliquid.liquidations.history('BTC', {
+    start: Date.now() - 86400000,
+    end: Date.now(),
+    cursor: liquidations.nextCursor,
+    limit: 1000
+  });
+  allLiquidations.push(...next.data);
+}
+
+// Get liquidations for a specific user
+const userLiquidations = await client.hyperliquid.liquidations.byUser('0x1234...', {
+  start: Date.now() - 86400000 * 7,
+  end: Date.now(),
+  coin: 'BTC'  // optional filter
+});
+```
+
 ### Candles (OHLCV)
 
 Get historical OHLCV candle data aggregated from trades.
@@ -532,11 +564,13 @@ import type {
   OrderBook,
   PriceLevel,
   Trade,
+  Candle,
   Instrument,
   LighterInstrument,
   LighterGranularity,
   FundingRate,
   OpenInterest,
+  Liquidation,
   CursorResponse,
   WsOptions,
   WsChannel,

package/dist/index.d.mts

@@ -684,11 +684,8 @@ declare class OrderBookResource {
  *
  * @example
  * ```typescript
- * // Get recent trades
- * const trades = await client.trades.recent('BTC');
- *
  * // Get trade history with cursor-based pagination (recommended)
- * let result = await client.trades.list('BTC', {
+ * let result = await client.hyperliquid.trades.list('BTC', {
  *   start: Date.now() - 86400000,
  *   end: Date.now(),
  *   limit: 1000
@@ -697,7 +694,7 @@ declare class OrderBookResource {
  * // Get all pages
  * const allTrades = [...result.data];
  * while (result.nextCursor) {
- *   result = await client.trades.list('BTC', {
+ *   result = await client.hyperliquid.trades.list('BTC', {
  *     start: Date.now() - 86400000,
  *     end: Date.now(),
  *     cursor: result.nextCursor,
@@ -705,6 +702,9 @@ declare class OrderBookResource {
  *   });
  *   allTrades.push(...result.data);
  * }
+ *
+ * // Get recent trades (Lighter only - has real-time data)
+ * const recent = await client.lighter.trades.recent('BTC');
  * ```
  */
 declare class TradesResource {
@@ -743,7 +743,11 @@ declare class TradesResource {
      */
     list(coin: string, params: GetTradesCursorParams): Promise<CursorResponse<Trade[]>>;
     /**
-     * Get most recent trades for a coin
+     * 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.
      *
      * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
      * @param limit - Number of trades to return (default: 100)

package/dist/index.d.ts

@@ -684,11 +684,8 @@ declare class OrderBookResource {
  *
  * @example
  * ```typescript
- * // Get recent trades
- * const trades = await client.trades.recent('BTC');
- *
  * // Get trade history with cursor-based pagination (recommended)
- * let result = await client.trades.list('BTC', {
+ * let result = await client.hyperliquid.trades.list('BTC', {
  *   start: Date.now() - 86400000,
  *   end: Date.now(),
  *   limit: 1000
@@ -697,7 +694,7 @@ declare class OrderBookResource {
  * // Get all pages
  * const allTrades = [...result.data];
  * while (result.nextCursor) {
- *   result = await client.trades.list('BTC', {
+ *   result = await client.hyperliquid.trades.list('BTC', {
  *     start: Date.now() - 86400000,
  *     end: Date.now(),
  *     cursor: result.nextCursor,
@@ -705,6 +702,9 @@ declare class OrderBookResource {
  *   });
  *   allTrades.push(...result.data);
  * }
+ *
+ * // Get recent trades (Lighter only - has real-time data)
+ * const recent = await client.lighter.trades.recent('BTC');
  * ```
  */
 declare class TradesResource {
@@ -743,7 +743,11 @@ declare class TradesResource {
      */
     list(coin: string, params: GetTradesCursorParams): Promise<CursorResponse<Trade[]>>;
     /**
-     * Get most recent trades for a coin
+     * 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.
      *
      * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
      * @param limit - Number of trades to return (default: 100)

package/dist/index.js

@@ -521,7 +521,11 @@ var TradesResource = class {
     };
   }
   /**
-   * Get most recent trades for a coin
+   * 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.
    *
    * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
    * @param limit - Number of trades to return (default: 100)