@0xarchive/sdk 0.5.1 → 0.5.3

package/dist/index.js

@@ -34,6 +34,9 @@ __export(index_exports, {
   InstrumentSchema: () => InstrumentSchema,
   InstrumentTypeSchema: () => InstrumentTypeSchema,
   LighterClient: () => LighterClient,
+  LiquidationArrayResponseSchema: () => LiquidationArrayResponseSchema,
+  LiquidationSchema: () => LiquidationSchema,
+  LiquidationSideSchema: () => LiquidationSideSchema,
   OpenInterestArrayResponseSchema: () => OpenInterestArrayResponseSchema,
   OpenInterestResponseSchema: () => OpenInterestResponseSchema,
   OpenInterestSchema: () => OpenInterestSchema,
@@ -265,6 +268,21 @@ var OpenInterestSchema = import_zod.z.object({
   impactBidPrice: import_zod.z.string().optional(),
   impactAskPrice: import_zod.z.string().optional()
 });
+var LiquidationSideSchema = import_zod.z.enum(["B", "S"]);
+var LiquidationSchema = import_zod.z.object({
+  coin: import_zod.z.string(),
+  timestamp: import_zod.z.string(),
+  liquidatedUser: import_zod.z.string(),
+  liquidatorUser: import_zod.z.string(),
+  price: import_zod.z.string(),
+  size: import_zod.z.string(),
+  side: LiquidationSideSchema,
+  markPrice: import_zod.z.string().optional(),
+  closedPnl: import_zod.z.string().optional(),
+  direction: import_zod.z.string().optional(),
+  tradeId: import_zod.z.number().optional(),
+  txHash: import_zod.z.string().optional()
+});
 var CandleIntervalSchema = import_zod.z.enum(["1m", "5m", "15m", "30m", "1h", "4h", "1d", "1w"]);
 var CandleSchema = import_zod.z.object({
   timestamp: import_zod.z.string(),
@@ -276,7 +294,7 @@ var CandleSchema = import_zod.z.object({
   quoteVolume: import_zod.z.number().optional(),
   tradeCount: import_zod.z.number().optional()
 });
-var WsChannelSchema = import_zod.z.enum(["orderbook", "trades", "candles", "ticker", "all_tickers"]);
+var WsChannelSchema = import_zod.z.enum(["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]);
 var WsConnectionStateSchema = import_zod.z.enum(["connecting", "connected", "disconnected", "reconnecting"]);
 var WsSubscribedSchema = import_zod.z.object({
   type: import_zod.z.literal("subscribed"),
@@ -392,6 +410,7 @@ var FundingRateArrayResponseSchema = ApiResponseSchema(import_zod.z.array(Fundin
 var OpenInterestResponseSchema = ApiResponseSchema(OpenInterestSchema);
 var OpenInterestArrayResponseSchema = ApiResponseSchema(import_zod.z.array(OpenInterestSchema));
 var CandleArrayResponseSchema = ApiResponseSchema(import_zod.z.array(CandleSchema));
+var LiquidationArrayResponseSchema = ApiResponseSchema(import_zod.z.array(LiquidationSchema));
 
 // src/resources/orderbook.ts
 var OrderBookResource = class {
@@ -502,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)
@@ -688,6 +711,54 @@ var CandlesResource = class {
   }
 };
 
+// src/resources/liquidations.ts
+var LiquidationsResource = class {
+  constructor(http, basePath = "/v1") {
+    this.http = http;
+    this.basePath = basePath;
+  }
+  /**
+   * Get liquidation history for a coin with cursor-based pagination
+   *
+   * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
+   * @param params - Time range and cursor pagination parameters (start and end are required)
+   * @returns CursorResponse with liquidation records and nextCursor for pagination
+   */
+  async history(coin, params) {
+    const response = await this.http.get(
+      `${this.basePath}/liquidations/${coin.toUpperCase()}`,
+      params,
+      this.http.validationEnabled ? LiquidationArrayResponseSchema : void 0
+    );
+    return {
+      data: response.data,
+      nextCursor: response.meta.nextCursor
+    };
+  }
+  /**
+   * Get liquidation history for a specific user
+   *
+   * This returns liquidations where the user was either:
+   * - The liquidated party (their position was liquidated)
+   * - The liquidator (they executed the liquidation)
+   *
+   * @param userAddress - User's wallet address (e.g., '0x1234...')
+   * @param params - Time range and cursor pagination parameters (start and end are required)
+   * @returns CursorResponse with liquidation records and nextCursor for pagination
+   */
+  async byUser(userAddress, params) {
+    const response = await this.http.get(
+      `${this.basePath}/liquidations/user/${userAddress}`,
+      params,
+      this.http.validationEnabled ? LiquidationArrayResponseSchema : void 0
+    );
+    return {
+      data: response.data,
+      nextCursor: response.meta.nextCursor
+    };
+  }
+};
+
 // src/exchanges.ts
 var HyperliquidClient = class {
   /**
@@ -714,6 +785,10 @@ var HyperliquidClient = class {
    * OHLCV candle data
    */
   candles;
+  /**
+   * Liquidation events (May 2025+)
+   */
+  liquidations;
   constructor(http) {
     const basePath = "/v1/hyperliquid";
     this.orderbook = new OrderBookResource(http, basePath);
@@ -722,6 +797,7 @@ var HyperliquidClient = class {
     this.funding = new FundingResource(http, basePath);
     this.openInterest = new OpenInterestResource(http, basePath);
     this.candles = new CandlesResource(http, basePath);
+    this.liquidations = new LiquidationsResource(http, basePath);
   }
 };
 var LighterClient = class {
@@ -1378,6 +1454,9 @@ var OxArchiveWs = class {
   InstrumentSchema,
   InstrumentTypeSchema,
   LighterClient,
+  LiquidationArrayResponseSchema,
+  LiquidationSchema,
+  LiquidationSideSchema,
   OpenInterestArrayResponseSchema,
   OpenInterestResponseSchema,
   OpenInterestSchema,