@0xarchive/sdk 1.4.0 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -248,6 +248,241 @@ interface Hip3Instrument {
248
248
  /** Timestamp of latest data point */
249
249
  latestTimestamp?: string;
250
250
  }
251
+ /**
252
+ * HIP-4 outcome-market per-side instrument metadata.
253
+ *
254
+ * Returned from `/v1/hyperliquid/hip4/instruments` and
255
+ * `/v1/hyperliquid/hip4/instruments/{symbol}`. One row per side (`#0`, `#1`, ...).
256
+ * Coin format: `#<10*outcome_id + side>` (e.g. `#0` = outcome 0 / Yes, `#1` = outcome 0 / No).
257
+ *
258
+ * Symbol path encoding: the backend accepts both the bare numeric form (`0`, `1`)
259
+ * and the on-chain `#`-prefixed form (`#0`, `#1`). The bare form is recommended in
260
+ * URLs to avoid `%23` encoding hassles. The SDK passes the value through as-is —
261
+ * it does NOT auto-encode `#`.
262
+ *
263
+ * Note: HIP-4 `mark_price` / `midPrice` on related endpoints (open interest,
264
+ * prices, summary) are implied probabilities in [0, 1], not USD prices.
265
+ */
266
+ interface Hip4Outcome {
267
+ /** Numeric outcome id (groups two sides under a single market). */
268
+ outcomeId: number;
269
+ /** Side index within the outcome (0 = Yes, 1 = No). */
270
+ side: number;
271
+ /** Public asset_id: 100_000_000 + 10*outcome_id + side. */
272
+ assetId: number;
273
+ /** Coin string with leading `#` (e.g. `#0`). Backend also accepts the bare numeric form. */
274
+ coin: string;
275
+ /** Same as `coin` for HIP-4. */
276
+ symbol: string;
277
+ /** Human-readable market name including side suffix. */
278
+ name?: string;
279
+ /** Raw description string from upstream (pipe-delimited key:value pairs). */
280
+ description?: string;
281
+ /** Side label (e.g. "Yes", "No"). */
282
+ sideName?: string;
283
+ /** Recurring class (e.g. "priceBinary"). */
284
+ recurringClass?: string;
285
+ /** Underlying asset for recurring markets (e.g. "BTC"). */
286
+ recurringUnderlying?: string;
287
+ /** Expiry timestamp ISO-8601 for recurring markets. */
288
+ recurringExpiry?: string;
289
+ /** Target price strike for recurring price-binary markets. */
290
+ recurringTargetPx?: number;
291
+ /** Cadence for recurring markets (e.g. "1d"). */
292
+ recurringPeriod?: string;
293
+ /** Builder/deployer wallet address. */
294
+ builderAddress?: string;
295
+ /** True after settlement; ingester unsubscribes settled markets. */
296
+ isSettled?: boolean;
297
+ /** Settlement value (typically 1.0 = Yes won, 0.0 = No won). Set when isSettled=true. */
298
+ settlementValue?: number;
299
+ /** Settlement timestamp (ISO-8601). Set when isSettled=true. */
300
+ settlementAt?: string;
301
+ /** Per-side human-readable title (e.g. "BTC above 78,213 on May 4 at 06:00 UTC? — Yes"). */
302
+ displayTitle?: string;
303
+ /** Per-side URL slug (e.g. "btc-above-78213-yes-may-04-0600"). */
304
+ slug?: string;
305
+ /** When this outcome was first observed in upstream metadata. */
306
+ firstSeenAt?: string;
307
+ /** When this outcome metadata row was last updated. */
308
+ lastUpdatedAt?: string;
309
+ }
310
+ /**
311
+ * HIP-4 aggregated open-interest snapshot for a single outcome.
312
+ * Populated only on the detail variant `/outcomes/{outcome_id}`; omitted on the list variant.
313
+ */
314
+ interface Hip4AggregatedOi {
315
+ /** Latest open interest contracts on side 0 (Yes). */
316
+ side0OpenInterestContracts?: number;
317
+ /** Latest open interest contracts on side 1 (No). */
318
+ side1OpenInterestContracts?: number;
319
+ /** Display sum of both sides' open interest contracts. */
320
+ outcomeDisplayOpenInterestContracts?: number;
321
+ /** Number of fully-paired YES+NO sets outstanding. */
322
+ pairedSetSupplyContracts?: number;
323
+ /** True if both sides report identical supply (sanity check). */
324
+ sideSupplyParity?: boolean;
325
+ /** Quote currency (always "USDH" today). */
326
+ currency?: string;
327
+ /** When this aggregate was computed. */
328
+ asOf?: string;
329
+ /** Source timestamp for side 0 OI. */
330
+ side0AsOf?: string;
331
+ /** Source timestamp for side 1 OI. */
332
+ side1AsOf?: string;
333
+ }
334
+ /**
335
+ * HIP-4 outcome-market per-outcome aggregate metadata.
336
+ *
337
+ * Returned from `/v1/hyperliquid/hip4/outcomes` (list, no `aggregatedOi`),
338
+ * `/v1/hyperliquid/hip4/outcomes/{outcome_id}` (detail, includes `aggregatedOi`),
339
+ * and `/v1/hyperliquid/hip4/outcomes/by-slug/{slug}` (detail, includes `aggregatedOi`).
340
+ * One row per outcome (combines both sides into a single market view).
341
+ *
342
+ * Note: HIP-4 mark/mid prices on related endpoints are implied probabilities
343
+ * in [0, 1], not USD prices.
344
+ */
345
+ interface Hip4OutcomeAggregate {
346
+ /** Numeric outcome id. */
347
+ outcomeId: number;
348
+ /** Underlying market name (without side suffix). */
349
+ name?: string;
350
+ /** Raw description string from upstream. */
351
+ descriptionRaw?: string;
352
+ /** Outcome class (e.g. "priceBinary"). */
353
+ class?: string;
354
+ /** Underlying asset (e.g. "BTC"). */
355
+ underlying?: string;
356
+ /** Expiry timestamp ISO-8601. */
357
+ expiry?: string;
358
+ /** Strike price for price-binary markets (USD, not a probability). */
359
+ targetPrice?: number;
360
+ /** Cadence (e.g. "1d"). */
361
+ period?: string;
362
+ /** Per-side specs for this outcome. */
363
+ sideSpecs?: Hip4OutcomeSideSpec[];
364
+ /** True after settlement. */
365
+ isSettled?: boolean;
366
+ /** Status (e.g. "live", "settled"). */
367
+ status?: string;
368
+ /** Source seen-at timestamp. */
369
+ sourceSeenAt?: string;
370
+ /** Outcome-level human-readable title (no side suffix). e.g. "BTC above 78,213 on May 4 at 06:00 UTC?" */
371
+ displayTitle?: string;
372
+ /** Outcome-level URL slug (e.g. "btc-above-78213-may-04-0600"). */
373
+ slug?: string;
374
+ /**
375
+ * Two-element pair of side coins, ordered by side (`[#side0, #side1]`).
376
+ * Convenience for clients that just want to know which `#N` codes belong to
377
+ * this outcome without iterating `sideSpecs`.
378
+ */
379
+ outcomePair?: [string, string];
380
+ /** Latest aggregated OI (detail endpoint only). */
381
+ aggregatedOi?: Hip4AggregatedOi;
382
+ }
383
+ /** Per-side spec embedded in `Hip4OutcomeAggregate.sideSpecs`. */
384
+ interface Hip4OutcomeSideSpec {
385
+ /** Side index (0 = Yes, 1 = No). */
386
+ side: number;
387
+ /** Side label. */
388
+ name?: string;
389
+ /** Coin string (e.g. `#0`). */
390
+ coin: string;
391
+ /** Public asset_id. */
392
+ assetId?: number;
393
+ /** Per-side human-readable title. */
394
+ displayTitle?: string;
395
+ /** Per-side URL slug. */
396
+ slug?: string;
397
+ }
398
+ /**
399
+ * Hyperliquid Spot pair metadata.
400
+ *
401
+ * Returned from `/v1/hyperliquid/spot/pairs` and
402
+ * `/v1/hyperliquid/spot/pairs/{symbol}`. Symbols are dashed canonical
403
+ * (`HYPE-USDC`, `PURR-USDC`); the server resolves the dashed form to
404
+ * Hyperliquid's wire formats (`PURR/USDC`, `@107`) internally.
405
+ *
406
+ * Spot has no funding, no open interest, no liquidations, and no candles by
407
+ * design (those are perpetual constructs). The SDK intentionally omits
408
+ * those resources from the spot client.
409
+ */
410
+ interface SpotPair {
411
+ /** Dashed canonical symbol (e.g. `HYPE-USDC`, `PURR-USDC`). */
412
+ symbol: string;
413
+ /** Base asset name (e.g. `HYPE`, `PURR`). */
414
+ baseAsset: string;
415
+ /** Quote asset name (typically `USDC`). */
416
+ quoteAsset: string;
417
+ /** Hyperliquid wire format (e.g. `PURR/USDC`, `@107`). */
418
+ wireSymbol?: string;
419
+ /** Hyperliquid asset index (e.g. `107` for `@107`). */
420
+ assetIndex?: number;
421
+ /** Size decimal precision. */
422
+ szDecimals?: number;
423
+ /** Price decimal precision. */
424
+ pxDecimals?: number;
425
+ /** Whether the pair is currently tradeable. */
426
+ isActive?: boolean;
427
+ /** Latest mark / mid price observed. */
428
+ markPrice?: number;
429
+ /** Latest mid price observed. */
430
+ midPrice?: number;
431
+ /** Timestamp of the latest market data point. */
432
+ latestTimestamp?: string;
433
+ }
434
+ /**
435
+ * Hyperliquid Spot TWAP status record.
436
+ *
437
+ * Returned from `/v1/hyperliquid/spot/twap/{symbol}` and
438
+ * `/v1/hyperliquid/spot/twap/user/{user}`. TWAP statuses come from the L4
439
+ * order stream; field shape mirrors the upstream Hyperliquid TWAP status.
440
+ * Loosely typed because upstream includes a number of optional fields and
441
+ * keeps adding to the schema.
442
+ */
443
+ interface SpotTwapStatus {
444
+ /** Dashed canonical symbol (e.g. `HYPE-USDC`). */
445
+ coin: string;
446
+ /** Status timestamp (UTC). */
447
+ timestamp: string;
448
+ /** TWAP execution id assigned by Hyperliquid. */
449
+ twapId?: number;
450
+ /** User wallet address that owns the TWAP. */
451
+ userAddress?: string;
452
+ /** Side: `B` (buy) or `A` (sell). */
453
+ side?: TradeSide;
454
+ /** Order size remaining for the TWAP. */
455
+ size?: string;
456
+ /** Total filled size so far. */
457
+ filledSize?: string;
458
+ /** Notional executed in quote currency. */
459
+ filledNotional?: string;
460
+ /** TWAP minutes window length. */
461
+ minutes?: number;
462
+ /** True if the TWAP is randomized. */
463
+ randomize?: boolean;
464
+ /** Reduce-only flag. */
465
+ reduceOnly?: boolean;
466
+ /** Status string (`activated`, `terminated`, `error`, etc.). */
467
+ status?: string;
468
+ /** Error message when status is `error`. */
469
+ error?: string;
470
+ }
471
+ /** Filter params for `/v1/hyperliquid/hip4/outcomes`. */
472
+ interface Hip4ListOutcomesParams {
473
+ /** Filter by settlement state. Omit to return all. */
474
+ isSettled?: boolean;
475
+ /**
476
+ * Slug filter. When provided, the response is a single-element list (or empty)
477
+ * containing the outcome whose per-outcome OR per-side slug matches. Composes
478
+ * with `isSettled`.
479
+ */
480
+ slug?: string;
481
+ /** Cursor for next page. */
482
+ cursor?: number | string;
483
+ /** Max results per page. */
484
+ limit?: number;
485
+ }
251
486
  /**
252
487
  * Funding rate record
253
488
  */
@@ -321,8 +556,14 @@ interface Liquidation {
321
556
  price: string;
322
557
  /** Liquidation size */
323
558
  size: string;
324
- /** Side: 'B' (buy) or 'S' (sell) */
325
- side: 'B' | 'S';
559
+ /**
560
+ * Trade side of the liquidating fill. Follows the trade convention:
561
+ * `'A'` (ask, sell-side fill, long was liquidated) or `'B'` (bid, buy-side
562
+ * fill, short was liquidated). Liquidations now share the trade wire shape
563
+ * (each row is a fill with `is_liquidation: true`) so this matches the
564
+ * `side` value on `Trade`. See CHANGELOG 1.6.0.
565
+ */
566
+ side: 'A' | 'B';
326
567
  /** Mark price at time of liquidation */
327
568
  markPrice?: string;
328
569
  /** Realized PnL from the liquidation */
@@ -335,10 +576,13 @@ interface Liquidation {
335
576
  txHash?: string;
336
577
  }
337
578
  /**
338
- * Parameters for getting liquidation history
579
+ * Parameters for getting liquidation history.
580
+ *
581
+ * Currently identical to `CursorPaginationParams`. Kept as a named type so
582
+ * that future liquidation-specific filters (e.g. `side`, `minSize`) can be
583
+ * added without breaking callers.
339
584
  */
340
- interface LiquidationHistoryParams extends CursorPaginationParams {
341
- }
585
+ type LiquidationHistoryParams = CursorPaginationParams;
342
586
  /**
343
587
  * Parameters for getting liquidations by user
344
588
  */
@@ -475,22 +719,35 @@ interface PriceHistoryParams extends CursorPaginationParams {
475
719
  * WebSocket channel types.
476
720
  *
477
721
  * - ticker/all_tickers: real-time only
478
- * - liquidations: historical only (May 2025+)
479
- * - hip3_liquidations: historical only (Feb 2026+)
722
+ * - liquidations: realtime + replay (Hyperliquid; live as of 1.6.0)
723
+ * - hip3_liquidations: realtime + replay (HIP-3; live as of 1.6.0)
480
724
  * - open_interest, funding, lighter_open_interest, lighter_funding,
481
725
  * hip3_open_interest, hip3_funding: historical only (replay/stream)
726
+ *
727
+ * HIP-4 channels (outcome contracts; no funding, no liquidations, no candles):
728
+ * - hip4_orderbook, hip4_trades, hip4_open_interest: realtime + replay
729
+ * - hip4_l4_diffs, hip4_l4_orders: real-time only (Pro+)
730
+ *
731
+ * Liquidation messages share the trade wire format: each item is a fill row
732
+ * with `is_liquidation: true`.
482
733
  */
483
- type WsChannel = 'orderbook' | 'trades' | 'candles' | 'liquidations' | 'ticker' | 'all_tickers' | 'open_interest' | 'funding' | 'lighter_orderbook' | 'lighter_trades' | 'lighter_candles' | 'lighter_open_interest' | 'lighter_funding' | 'lighter_l3_orderbook' | 'hip3_orderbook' | 'hip3_trades' | 'hip3_candles' | 'hip3_open_interest' | 'hip3_funding' | 'hip3_liquidations' | 'l4_diffs' | 'l4_orders' | 'hip3_l4_diffs' | 'hip3_l4_orders';
734
+ type WsChannel = 'orderbook' | 'trades' | 'candles' | 'liquidations' | 'ticker' | 'all_tickers' | 'open_interest' | 'funding' | 'lighter_orderbook' | 'lighter_trades' | 'lighter_candles' | 'lighter_open_interest' | 'lighter_funding' | 'lighter_l3_orderbook' | 'hip3_orderbook' | 'hip3_trades' | 'hip3_candles' | 'hip3_open_interest' | 'hip3_funding' | 'hip3_liquidations' | 'hip4_orderbook' | 'hip4_trades' | 'hip4_open_interest' | 'spot_orderbook' | 'spot_trades' | 'spot_l4_diffs' | 'spot_l4_orders' | 'spot_twap' | 'l4_diffs' | 'l4_orders' | 'hip3_l4_diffs' | 'hip3_l4_orders' | 'hip4_l4_diffs' | 'hip4_l4_orders';
484
735
  /** Subscribe message from client */
485
736
  interface WsSubscribe {
486
737
  op: 'subscribe';
487
738
  channel: WsChannel;
739
+ /** Wire field for coin/symbol. The server accepts `symbol` (canonical)
740
+ * and `coin` (deprecated alias) during the migration period. */
741
+ symbol?: string;
742
+ /** @deprecated Use `symbol`. The server still accepts `coin` for now. */
488
743
  coin?: string;
489
744
  }
490
745
  /** Unsubscribe message from client */
491
746
  interface WsUnsubscribe {
492
747
  op: 'unsubscribe';
493
748
  channel: WsChannel;
749
+ symbol?: string;
750
+ /** @deprecated Use `symbol`. */
494
751
  coin?: string;
495
752
  }
496
753
  /** Ping message from client */
@@ -504,6 +761,8 @@ interface WsReplay {
504
761
  channel?: WsChannel;
505
762
  /** Multiple channels for multi-channel replay. Mutually exclusive with `channel`. */
506
763
  channels?: WsChannel[];
764
+ symbol?: string;
765
+ /** @deprecated Use `symbol`. */
507
766
  coin?: string;
508
767
  /** Start timestamp (Unix ms) */
509
768
  start: number;
@@ -537,6 +796,8 @@ interface WsStream {
537
796
  channel?: WsChannel;
538
797
  /** Multiple channels for multi-channel streaming. Mutually exclusive with `channel`. */
539
798
  channels?: WsChannel[];
799
+ symbol?: string;
800
+ /** @deprecated Use `symbol`. */
540
801
  coin?: string;
541
802
  /** Start timestamp (Unix ms) */
542
803
  start: number;
@@ -732,8 +993,29 @@ interface WsL4Batch {
732
993
  coin: string;
733
994
  data: any[];
734
995
  }
996
+ /**
997
+ * HIP-4 outcome settlement notification.
998
+ *
999
+ * Pushed once per `(outcome_id, side)` when `hip4_outcome_metadata.is_settled`
1000
+ * flips to true. After delivering this message the server proactively
1001
+ * unsubscribes the client from every hip4_* subscription on the settled coin —
1002
+ * treat this as a terminal signal for the coin.
1003
+ */
1004
+ interface WsOutcomeSettled {
1005
+ type: 'outcome_settled';
1006
+ /** HIP-4 coin (e.g. `#55850`). */
1007
+ coin: string;
1008
+ /** Numeric outcome id. */
1009
+ outcome_id: number;
1010
+ /** Side index (0 = Yes, 1 = No). */
1011
+ side: number;
1012
+ /** Settlement value (typically 1.0 for the winning side, 0.0 for the losing side). */
1013
+ settlement_value?: number;
1014
+ /** Settlement timestamp (ISO-8601). */
1015
+ settlement_at?: string;
1016
+ }
735
1017
  /** Server message union type */
736
- type WsServerMessage = WsSubscribed | WsUnsubscribed | WsPong | WsError | WsData | WsReplayStarted | WsReplayPaused | WsReplayResumed | WsReplayCompleted | WsReplayStopped | WsReplaySnapshot | WsHistoricalData | WsHistoricalTickData | WsStreamStarted | WsStreamProgress | WsHistoricalBatch | WsStreamCompleted | WsStreamStopped | WsGapDetected | WsL4Snapshot | WsL4Batch;
1018
+ type WsServerMessage = WsSubscribed | WsUnsubscribed | WsPong | WsError | WsData | WsReplayStarted | WsReplayPaused | WsReplayResumed | WsReplayCompleted | WsReplayStopped | WsReplaySnapshot | WsHistoricalData | WsHistoricalTickData | WsStreamStarted | WsStreamProgress | WsHistoricalBatch | WsStreamCompleted | WsStreamStopped | WsGapDetected | WsL4Snapshot | WsL4Batch | WsOutcomeSettled;
737
1019
  /**
738
1020
  * WebSocket connection options.
739
1021
  *
@@ -910,7 +1192,7 @@ interface ExchangeCoverage {
910
1192
  }
911
1193
  /** Overall coverage response */
912
1194
  interface CoverageResponse {
913
- /** Coverage for all exchanges */
1195
+ /** Coverage for supported venue APIs */
914
1196
  exchanges: ExchangeCoverage[];
915
1197
  }
916
1198
  /** Gap information for per-symbol coverage */
@@ -1173,6 +1455,138 @@ declare class HttpClient {
1173
1455
  post<T>(path: string, body?: Record<string, unknown>, schema?: z.ZodType<T>): Promise<T>;
1174
1456
  }
1175
1457
 
1458
+ interface L4OrderBookParams {
1459
+ timestamp?: number | string;
1460
+ depth?: number;
1461
+ }
1462
+ /**
1463
+ * L4 Order Book API resource
1464
+ *
1465
+ * Access L4 orderbook snapshots, diffs, and history.
1466
+ *
1467
+ * @example
1468
+ * ```typescript
1469
+ * // Get current L4 orderbook
1470
+ * const orderbook = await client.hyperliquid.l4Orderbook.get('BTC');
1471
+ *
1472
+ * // Get L4 orderbook diffs
1473
+ * const diffs = await client.hyperliquid.l4Orderbook.diffs('BTC', {
1474
+ * start: Date.now() - 86400000,
1475
+ * end: Date.now(),
1476
+ * limit: 1000
1477
+ * });
1478
+ *
1479
+ * // Get L4 orderbook history
1480
+ * const history = await client.hyperliquid.l4Orderbook.history('BTC', {
1481
+ * start: Date.now() - 86400000,
1482
+ * end: Date.now(),
1483
+ * limit: 1000
1484
+ * });
1485
+ * ```
1486
+ */
1487
+ declare class L4OrderBookResource {
1488
+ private http;
1489
+ private basePath;
1490
+ private coinTransform;
1491
+ constructor(http: HttpClient, basePath?: string, coinTransform?: (s: string) => string);
1492
+ /**
1493
+ * Get L4 order book snapshot for a symbol
1494
+ *
1495
+ * @param symbol - The symbol (e.g., 'BTC', 'ETH')
1496
+ * @param params - Optional parameters (timestamp, depth)
1497
+ * @returns L4 order book snapshot
1498
+ */
1499
+ get(symbol: string, params?: L4OrderBookParams): Promise<any>;
1500
+ /**
1501
+ * Get L4 order book diffs with cursor-based pagination
1502
+ *
1503
+ * @param symbol - The symbol (e.g., 'BTC', 'ETH')
1504
+ * @param params - Time range and cursor pagination parameters
1505
+ * @returns CursorResponse with L4 orderbook diffs and nextCursor for pagination
1506
+ */
1507
+ diffs(symbol: string, params: CursorPaginationParams): Promise<CursorResponse<any[]>>;
1508
+ /**
1509
+ * Get L4 order book history with cursor-based pagination
1510
+ *
1511
+ * @param symbol - The symbol (e.g., 'BTC', 'ETH')
1512
+ * @param params - Time range and cursor pagination parameters
1513
+ * @returns CursorResponse with L4 orderbook snapshots and nextCursor for pagination
1514
+ */
1515
+ history(symbol: string, params: CursorPaginationParams): Promise<CursorResponse<any[]>>;
1516
+ }
1517
+
1518
+ interface OrderHistoryParams extends CursorPaginationParams {
1519
+ user?: string;
1520
+ status?: string;
1521
+ order_type?: string;
1522
+ }
1523
+ interface OrderFlowParams {
1524
+ start: number | string;
1525
+ end: number | string;
1526
+ interval?: string;
1527
+ limit?: number;
1528
+ }
1529
+ interface TpslParams extends CursorPaginationParams {
1530
+ user?: string;
1531
+ triggered?: boolean;
1532
+ }
1533
+ /**
1534
+ * Orders API resource
1535
+ *
1536
+ * @example
1537
+ * ```typescript
1538
+ * // Get order history
1539
+ * const result = await client.hyperliquid.orders.history('BTC', {
1540
+ * start: Date.now() - 86400000,
1541
+ * end: Date.now(),
1542
+ * limit: 1000
1543
+ * });
1544
+ *
1545
+ * // Get order flow
1546
+ * const flow = await client.hyperliquid.orders.flow('BTC', {
1547
+ * start: Date.now() - 86400000,
1548
+ * end: Date.now(),
1549
+ * interval: '1h'
1550
+ * });
1551
+ *
1552
+ * // Get TP/SL orders
1553
+ * const tpsl = await client.hyperliquid.orders.tpsl('BTC', {
1554
+ * start: Date.now() - 86400000,
1555
+ * end: Date.now()
1556
+ * });
1557
+ * ```
1558
+ */
1559
+ declare class OrdersResource {
1560
+ private http;
1561
+ private basePath;
1562
+ private coinTransform;
1563
+ constructor(http: HttpClient, basePath?: string, coinTransform?: (s: string) => string);
1564
+ /**
1565
+ * Get order history for a symbol with cursor-based pagination
1566
+ *
1567
+ * @param symbol - The symbol (e.g., 'BTC', 'ETH')
1568
+ * @param params - Time range, cursor pagination, and filter parameters
1569
+ * @returns CursorResponse with order records and nextCursor for pagination
1570
+ */
1571
+ history(symbol: string, params: OrderHistoryParams): Promise<CursorResponse<any[]>>;
1572
+ /**
1573
+ * Get order flow for a symbol
1574
+ *
1575
+ * @param symbol - The symbol (e.g., 'BTC', 'ETH')
1576
+ * @param params - Time range and interval parameters
1577
+ * @returns CursorResponse with order flow records
1578
+ */
1579
+ flow(symbol: string, params: OrderFlowParams): Promise<CursorResponse<any[]>>;
1580
+ /**
1581
+ * Get TP/SL orders for a symbol with cursor-based pagination
1582
+ *
1583
+ * @param symbol - The symbol (e.g., 'BTC', 'ETH')
1584
+ * @param params - Time range, cursor pagination, and filter parameters
1585
+ * @returns CursorResponse with TP/SL order records
1586
+ */
1587
+ tpsl(symbol: string, params: TpslParams): Promise<CursorResponse<any[]>>;
1588
+ }
1589
+
1176
1590
  /**
1177
1591
  * Orderbook Reconstructor for tick-level delta data.
1178
1592
  *
@@ -1587,14 +2001,18 @@ declare class TradesResource {
1587
2001
  /**
1588
2002
  * Get most recent trades for a symbol.
1589
2003
  *
1590
- * Note: This method is available for Lighter (client.lighter.trades.recent())
1591
- * and HIP-3 (client.hyperliquid.hip3.trades.recent()) which have real-time data
1592
- * ingestion. Hyperliquid uses hourly backfill so this endpoint is not available
1593
- * for Hyperliquid.
2004
+ * Note: This method is available on Lighter (`client.lighter.trades.recent()`),
2005
+ * HIP-3 (`client.hyperliquid.hip3.trades.recent()`), and HIP-4
2006
+ * (`client.hyperliquid.hip4.trades.recent()`) which have real-time ingestion.
2007
+ * Hyperliquid uses hourly S3 backfill and does NOT expose a recent endpoint —
2008
+ * calling `client.hyperliquid.trades.recent()` (or the legacy
2009
+ * `client.trades.recent()`) throws a structured `OxArchiveError` rather than
2010
+ * letting the request fail with an opaque JSON parse error.
1594
2011
  *
1595
2012
  * @param symbol - The symbol (e.g., 'BTC', 'ETH')
1596
2013
  * @param limit - Number of trades to return (default: 100)
1597
2014
  * @returns Array of recent trades
2015
+ * @throws {OxArchiveError} When called on the bare Hyperliquid namespace.
1598
2016
  */
1599
2017
  recent(symbol: string, limit?: number): Promise<Trade[]>;
1600
2018
  }
@@ -1698,6 +2116,66 @@ declare class Hip3InstrumentsResource {
1698
2116
  */
1699
2117
  get(coin: string): Promise<Hip3Instrument>;
1700
2118
  }
2119
+ /**
2120
+ * HIP-4 Outcome-Market Per-Side Instruments resource.
2121
+ *
2122
+ * Returns one row per `#N` coin (each outcome has 2 sides). For per-outcome
2123
+ * aggregate metadata (with both sides combined), use `Hip4OutcomesResource`.
2124
+ *
2125
+ * The backend accepts both the bare numeric form (`'0'`, `'1'`) and the
2126
+ * `#`-prefixed form (`'#0'`, `'#1'`). The SDK URL-encodes `#` to `%23` so the
2127
+ * `#`-prefixed form (which is the canonical form returned by the API in
2128
+ * `coin` fields) survives `fetch`'s URL-fragment parsing.
2129
+ *
2130
+ * @example
2131
+ * ```typescript
2132
+ * // List all HIP-4 per-side instruments
2133
+ * const instruments = await client.hyperliquid.hip4.instruments.list();
2134
+ *
2135
+ * // Both forms work (SDK encodes `#` on the wire)
2136
+ * const yes = await client.hyperliquid.hip4.instruments.get('#0');
2137
+ * const yesAlt = await client.hyperliquid.hip4.instruments.get('0');
2138
+ * ```
2139
+ */
2140
+ declare class Hip4InstrumentsResource {
2141
+ private http;
2142
+ private basePath;
2143
+ private coinTransform;
2144
+ constructor(http: HttpClient, basePath?: string, coinTransform?: (c: string) => string);
2145
+ list(): Promise<Hip4Outcome[]>;
2146
+ get(coin: string): Promise<Hip4Outcome>;
2147
+ }
2148
+ /**
2149
+ * HIP-4 Outcome aggregates resource (per-outcome view).
2150
+ *
2151
+ * No HIP-3 analog. List endpoint excludes `aggregatedOi`; detail endpoint
2152
+ * populates it with the latest both-sides OI snapshot.
2153
+ *
2154
+ * @example
2155
+ * ```typescript
2156
+ * // List live (unsettled) outcomes
2157
+ * const live = await client.hyperliquid.hip4.outcomes.list({ isSettled: false });
2158
+ *
2159
+ * // Get a single outcome with aggregated OI
2160
+ * const detail = await client.hyperliquid.hip4.outcomes.get(0);
2161
+ * console.log(detail.aggregatedOi?.outcomeDisplayOpenInterestContracts);
2162
+ * ```
2163
+ */
2164
+ declare class Hip4OutcomesResource {
2165
+ private http;
2166
+ private basePath;
2167
+ constructor(http: HttpClient, basePath?: string);
2168
+ /** List per-outcome aggregates. `aggregatedOi` is omitted on list responses. */
2169
+ list(params?: Hip4ListOutcomesParams): Promise<CursorResponse<Hip4OutcomeAggregate[]>>;
2170
+ /** Get a single outcome aggregate. Response includes `aggregatedOi`. */
2171
+ get(outcomeId: number | string): Promise<Hip4OutcomeAggregate>;
2172
+ /**
2173
+ * Look up an outcome aggregate by its synthesized slug. Accepts the
2174
+ * per-outcome slug (`btc-above-78213-may-04-0600`) OR a per-side slug
2175
+ * (`btc-above-78213-yes-may-04-0600`). Response includes `aggregatedOi`.
2176
+ */
2177
+ getBySlug(slug: string): Promise<Hip4OutcomeAggregate>;
2178
+ }
1701
2179
 
1702
2180
  /**
1703
2181
  * Funding rates API resource
@@ -1930,7 +2408,7 @@ declare class LiquidationsResource {
1930
2408
  * const status = await client.dataQuality.status();
1931
2409
  * console.log(`System status: ${status.status}`);
1932
2410
  *
1933
- * // Get coverage for all exchanges
2411
+ * // Get coverage across venue APIs
1934
2412
  * const coverage = await client.dataQuality.coverage();
1935
2413
  *
1936
2414
  * // Get symbol-specific coverage with gap detection
@@ -1948,7 +2426,7 @@ declare class DataQualityResource {
1948
2426
  /**
1949
2427
  * Get overall system health status
1950
2428
  *
1951
- * @returns StatusResponse with overall status, per-exchange status,
2429
+ * @returns StatusResponse with overall status, per-scope status,
1952
2430
  * per-data-type status, and active incident count
1953
2431
  *
1954
2432
  * @example
@@ -1962,9 +2440,9 @@ declare class DataQualityResource {
1962
2440
  */
1963
2441
  status(): Promise<StatusResponse>;
1964
2442
  /**
1965
- * Get data coverage summary for all exchanges
2443
+ * Get data coverage summary across venue APIs
1966
2444
  *
1967
- * @returns CoverageResponse with coverage info for all exchanges and data types
2445
+ * @returns CoverageResponse with coverage info for supported venue APIs and data types
1968
2446
  *
1969
2447
  * @example
1970
2448
  * ```typescript
@@ -1979,10 +2457,10 @@ declare class DataQualityResource {
1979
2457
  */
1980
2458
  coverage(): Promise<CoverageResponse>;
1981
2459
  /**
1982
- * Get data coverage for a specific exchange
2460
+ * Get data coverage for a specific venue scope
1983
2461
  *
1984
- * @param exchange - Exchange name ('hyperliquid', 'lighter', or 'hip3')
1985
- * @returns ExchangeCoverage with coverage info for all data types on this exchange
2462
+ * @param exchange - Venue scope ('hyperliquid', 'lighter', 'hip3', or 'hip4')
2463
+ * @returns ExchangeCoverage with coverage info for all data types on this venue scope
1986
2464
  *
1987
2465
  * @example
1988
2466
  * ```typescript
@@ -1992,12 +2470,12 @@ declare class DataQualityResource {
1992
2470
  */
1993
2471
  exchangeCoverage(exchange: string): Promise<ExchangeCoverage>;
1994
2472
  /**
1995
- * Get data coverage for a specific symbol on an exchange
2473
+ * Get data coverage for a specific symbol on a venue scope
1996
2474
  *
1997
2475
  * Includes gap detection, empirical data cadence, and hour-level historical coverage.
1998
2476
  * Supports optional time bounds for gap detection (default: last 30 days).
1999
2477
  *
2000
- * @param exchange - Exchange name ('hyperliquid', 'lighter', or 'hip3')
2478
+ * @param exchange - Venue scope ('hyperliquid', 'lighter', 'hip3', or 'hip4')
2001
2479
  * @param symbol - Symbol name (e.g., 'BTC', 'ETH', or HIP3 coins like 'xyz:XYZ100')
2002
2480
  * @param options - Optional time bounds for gap detection window
2003
2481
  * @returns SymbolCoverageResponse with per-data-type coverage including gaps, cadence, and historical coverage
@@ -2057,7 +2535,7 @@ declare class DataQualityResource {
2057
2535
  */
2058
2536
  getIncident(incidentId: string): Promise<Incident>;
2059
2537
  /**
2060
- * Get current latency metrics for all exchanges
2538
+ * Get current latency metrics for supported venue APIs
2061
2539
  *
2062
2540
  * @returns LatencyResponse with WebSocket, REST API, and data freshness metrics
2063
2541
  *
@@ -2105,199 +2583,67 @@ declare class DataQualityResource {
2105
2583
  * // Step 1: Get a challenge
2106
2584
  * const challenge = await client.web3.challenge('0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18');
2107
2585
  *
2108
- * // Step 2: Sign the message with your wallet, then submit
2109
- * const result = await client.web3.signup(challenge.message, signature);
2110
- * console.log(`API key: ${result.apiKey}`);
2111
- * ```
2112
- */
2113
- declare class Web3Resource {
2114
- private http;
2115
- constructor(http: HttpClient);
2116
- /**
2117
- * Get a SIWE challenge message to sign.
2118
- *
2119
- * @param address - Ethereum wallet address
2120
- * @returns SIWE message and nonce. Sign the message with personal_sign (EIP-191).
2121
- */
2122
- challenge(address: string): Promise<SiweChallenge>;
2123
- /**
2124
- * Create a free-tier account and get an API key.
2125
- *
2126
- * @param message - The SIWE message from {@link challenge}
2127
- * @param signature - Hex-encoded signature from personal_sign
2128
- * @returns API key, tier, and wallet address
2129
- */
2130
- signup(message: string, signature: string): Promise<Web3SignupResult>;
2131
- /**
2132
- * List all API keys for the authenticated wallet.
2133
- *
2134
- * @param message - The SIWE message from {@link challenge}
2135
- * @param signature - Hex-encoded signature from personal_sign
2136
- * @returns List of API keys and wallet address
2137
- */
2138
- listKeys(message: string, signature: string): Promise<Web3KeysList>;
2139
- /**
2140
- * Revoke a specific API key.
2141
- *
2142
- * @param message - The SIWE message from {@link challenge}
2143
- * @param signature - Hex-encoded signature from personal_sign
2144
- * @param keyId - UUID of the key to revoke
2145
- * @returns Confirmation message and wallet address
2146
- */
2147
- revokeKey(message: string, signature: string, keyId: string): Promise<Web3RevokeResult>;
2148
- /**
2149
- * Get pricing info for a paid subscription (x402 flow, step 1).
2150
- *
2151
- * Returns the payment details needed to sign a USDC transfer on Base.
2152
- * After signing, pass the payment signature to {@link subscribe}.
2153
- *
2154
- * @param tier - Subscription tier: 'build' ($49/mo) or 'pro' ($199/mo)
2155
- * @returns Payment details (amount, asset, network, pay-to address)
2156
- */
2157
- subscribeQuote(tier: 'build' | 'pro'): Promise<Web3PaymentRequired>;
2158
- /**
2159
- * Complete a paid subscription with a signed x402 payment (step 2).
2160
- *
2161
- * Requires a payment signature from signing a USDC transfer (EIP-3009)
2162
- * for the amount returned by {@link subscribeQuote}.
2163
- *
2164
- * @param tier - Subscription tier: 'build' or 'pro'
2165
- * @param paymentSignature - Signed x402 payment (from EIP-3009 USDC transfer on Base)
2166
- * @returns API key, tier, expiration, and wallet address
2167
- */
2168
- subscribe(tier: 'build' | 'pro', paymentSignature: string): Promise<Web3SubscribeResult>;
2169
- }
2170
-
2171
- interface OrderHistoryParams extends CursorPaginationParams {
2172
- user?: string;
2173
- status?: string;
2174
- order_type?: string;
2175
- }
2176
- interface OrderFlowParams {
2177
- start: number | string;
2178
- end: number | string;
2179
- interval?: string;
2180
- limit?: number;
2181
- }
2182
- interface TpslParams extends CursorPaginationParams {
2183
- user?: string;
2184
- triggered?: boolean;
2185
- }
2186
- /**
2187
- * Orders API resource
2188
- *
2189
- * @example
2190
- * ```typescript
2191
- * // Get order history
2192
- * const result = await client.hyperliquid.orders.history('BTC', {
2193
- * start: Date.now() - 86400000,
2194
- * end: Date.now(),
2195
- * limit: 1000
2196
- * });
2197
- *
2198
- * // Get order flow
2199
- * const flow = await client.hyperliquid.orders.flow('BTC', {
2200
- * start: Date.now() - 86400000,
2201
- * end: Date.now(),
2202
- * interval: '1h'
2203
- * });
2204
- *
2205
- * // Get TP/SL orders
2206
- * const tpsl = await client.hyperliquid.orders.tpsl('BTC', {
2207
- * start: Date.now() - 86400000,
2208
- * end: Date.now()
2209
- * });
2210
- * ```
2211
- */
2212
- declare class OrdersResource {
2213
- private http;
2214
- private basePath;
2215
- private coinTransform;
2216
- constructor(http: HttpClient, basePath?: string, coinTransform?: (s: string) => string);
2217
- /**
2218
- * Get order history for a symbol with cursor-based pagination
2219
- *
2220
- * @param symbol - The symbol (e.g., 'BTC', 'ETH')
2221
- * @param params - Time range, cursor pagination, and filter parameters
2222
- * @returns CursorResponse with order records and nextCursor for pagination
2223
- */
2224
- history(symbol: string, params: OrderHistoryParams): Promise<CursorResponse<any[]>>;
2225
- /**
2226
- * Get order flow for a symbol
2227
- *
2228
- * @param symbol - The symbol (e.g., 'BTC', 'ETH')
2229
- * @param params - Time range and interval parameters
2230
- * @returns CursorResponse with order flow records
2231
- */
2232
- flow(symbol: string, params: OrderFlowParams): Promise<CursorResponse<any[]>>;
2233
- /**
2234
- * Get TP/SL orders for a symbol with cursor-based pagination
2235
- *
2236
- * @param symbol - The symbol (e.g., 'BTC', 'ETH')
2237
- * @param params - Time range, cursor pagination, and filter parameters
2238
- * @returns CursorResponse with TP/SL order records
2239
- */
2240
- tpsl(symbol: string, params: TpslParams): Promise<CursorResponse<any[]>>;
2241
- }
2242
-
2243
- interface L4OrderBookParams {
2244
- timestamp?: number | string;
2245
- depth?: number;
2246
- }
2247
- /**
2248
- * L4 Order Book API resource
2249
- *
2250
- * Access L4 orderbook snapshots, diffs, and history.
2251
- *
2252
- * @example
2253
- * ```typescript
2254
- * // Get current L4 orderbook
2255
- * const orderbook = await client.hyperliquid.l4Orderbook.get('BTC');
2256
- *
2257
- * // Get L4 orderbook diffs
2258
- * const diffs = await client.hyperliquid.l4Orderbook.diffs('BTC', {
2259
- * start: Date.now() - 86400000,
2260
- * end: Date.now(),
2261
- * limit: 1000
2262
- * });
2263
- *
2264
- * // Get L4 orderbook history
2265
- * const history = await client.hyperliquid.l4Orderbook.history('BTC', {
2266
- * start: Date.now() - 86400000,
2267
- * end: Date.now(),
2268
- * limit: 1000
2269
- * });
2586
+ * // Step 2: Sign the message with your wallet, then submit
2587
+ * const result = await client.web3.signup(challenge.message, signature);
2588
+ * console.log(`API key: ${result.apiKey}`);
2270
2589
  * ```
2271
2590
  */
2272
- declare class L4OrderBookResource {
2591
+ declare class Web3Resource {
2273
2592
  private http;
2274
- private basePath;
2275
- private coinTransform;
2276
- constructor(http: HttpClient, basePath?: string, coinTransform?: (s: string) => string);
2593
+ constructor(http: HttpClient);
2277
2594
  /**
2278
- * Get L4 order book snapshot for a symbol
2595
+ * Get a SIWE challenge message to sign.
2279
2596
  *
2280
- * @param symbol - The symbol (e.g., 'BTC', 'ETH')
2281
- * @param params - Optional parameters (timestamp, depth)
2282
- * @returns L4 order book snapshot
2597
+ * @param address - Ethereum wallet address
2598
+ * @returns SIWE message and nonce. Sign the message with personal_sign (EIP-191).
2283
2599
  */
2284
- get(symbol: string, params?: L4OrderBookParams): Promise<any>;
2600
+ challenge(address: string): Promise<SiweChallenge>;
2285
2601
  /**
2286
- * Get L4 order book diffs with cursor-based pagination
2602
+ * Create a free-tier account and get an API key.
2287
2603
  *
2288
- * @param symbol - The symbol (e.g., 'BTC', 'ETH')
2289
- * @param params - Time range and cursor pagination parameters
2290
- * @returns CursorResponse with L4 orderbook diffs and nextCursor for pagination
2604
+ * @param message - The SIWE message from {@link challenge}
2605
+ * @param signature - Hex-encoded signature from personal_sign
2606
+ * @returns API key, tier, and wallet address
2291
2607
  */
2292
- diffs(symbol: string, params: CursorPaginationParams): Promise<CursorResponse<any[]>>;
2608
+ signup(message: string, signature: string): Promise<Web3SignupResult>;
2293
2609
  /**
2294
- * Get L4 order book history with cursor-based pagination
2610
+ * List all API keys for the authenticated wallet.
2295
2611
  *
2296
- * @param symbol - The symbol (e.g., 'BTC', 'ETH')
2297
- * @param params - Time range and cursor pagination parameters
2298
- * @returns CursorResponse with L4 orderbook snapshots and nextCursor for pagination
2612
+ * @param message - The SIWE message from {@link challenge}
2613
+ * @param signature - Hex-encoded signature from personal_sign
2614
+ * @returns List of API keys and wallet address
2299
2615
  */
2300
- history(symbol: string, params: CursorPaginationParams): Promise<CursorResponse<any[]>>;
2616
+ listKeys(message: string, signature: string): Promise<Web3KeysList>;
2617
+ /**
2618
+ * Revoke a specific API key.
2619
+ *
2620
+ * @param message - The SIWE message from {@link challenge}
2621
+ * @param signature - Hex-encoded signature from personal_sign
2622
+ * @param keyId - UUID of the key to revoke
2623
+ * @returns Confirmation message and wallet address
2624
+ */
2625
+ revokeKey(message: string, signature: string, keyId: string): Promise<Web3RevokeResult>;
2626
+ /**
2627
+ * Get pricing info for a paid subscription (x402 flow, step 1).
2628
+ *
2629
+ * Returns the payment details needed to sign a USDC transfer on Base.
2630
+ * After signing, pass the payment signature to {@link subscribe}.
2631
+ *
2632
+ * @param tier - Subscription tier: 'build' ($49/mo) or 'pro' ($199/mo)
2633
+ * @returns Payment details (amount, asset, network, pay-to address)
2634
+ */
2635
+ subscribeQuote(tier: 'build' | 'pro'): Promise<Web3PaymentRequired>;
2636
+ /**
2637
+ * Complete a paid subscription with a signed x402 payment (step 2).
2638
+ *
2639
+ * Requires a payment signature from signing a USDC transfer (EIP-3009)
2640
+ * for the amount returned by {@link subscribeQuote}.
2641
+ *
2642
+ * @param tier - Subscription tier: 'build' or 'pro'
2643
+ * @param paymentSignature - Signed x402 payment (from EIP-3009 USDC transfer on Base)
2644
+ * @returns API key, tier, expiration, and wallet address
2645
+ */
2646
+ subscribe(tier: 'build' | 'pro', paymentSignature: string): Promise<Web3SubscribeResult>;
2301
2647
  }
2302
2648
 
2303
2649
  interface L2OrderBookParams {
@@ -2388,6 +2734,63 @@ declare class L3OrderBookResource {
2388
2734
  history(symbol: string, params: CursorPaginationParams): Promise<CursorResponse<any[]>>;
2389
2735
  }
2390
2736
 
2737
+ /**
2738
+ * Hyperliquid Spot pairs API resource.
2739
+ *
2740
+ * Pairs are the spot equivalent of HIP-3 / Hyperliquid `instruments`. Symbols
2741
+ * are dashed canonical (`HYPE-USDC`, `PURR-USDC`); the server resolves the
2742
+ * dashed form to Hyperliquid's wire formats (`PURR/USDC`, `@107`) internally.
2743
+ *
2744
+ * @example
2745
+ * ```typescript
2746
+ * const pairs = await client.spot.pairs.list();
2747
+ * const hype = await client.spot.pairs.get('HYPE-USDC');
2748
+ * ```
2749
+ */
2750
+ declare class SpotPairsResource {
2751
+ private http;
2752
+ private basePath;
2753
+ private coinTransform;
2754
+ constructor(http: HttpClient, basePath?: string, coinTransform?: (s: string) => string);
2755
+ /** List every active spot pair. */
2756
+ list(): Promise<SpotPair[]>;
2757
+ /**
2758
+ * Get a specific spot pair by dashed symbol (e.g. `HYPE-USDC`).
2759
+ */
2760
+ get(symbol: string): Promise<SpotPair>;
2761
+ }
2762
+ /**
2763
+ * Hyperliquid Spot TWAP statuses.
2764
+ *
2765
+ * TWAP statuses come from the L4 order stream (Singapore node). They can be
2766
+ * looked up by symbol (every TWAP touching this pair) or by user wallet
2767
+ * address (every TWAP this user has placed across all spot pairs).
2768
+ *
2769
+ * Live coverage from 2026-05-05.
2770
+ *
2771
+ * @example
2772
+ * ```typescript
2773
+ * const bySymbol = await client.spot.twap.bySymbol('HYPE-USDC', {
2774
+ * start: Date.now() - 86_400_000,
2775
+ * end: Date.now(),
2776
+ * });
2777
+ * const byUser = await client.spot.twap.byUser('0xabc...', {
2778
+ * start: Date.now() - 86_400_000,
2779
+ * end: Date.now(),
2780
+ * });
2781
+ * ```
2782
+ */
2783
+ declare class SpotTwapResource {
2784
+ private http;
2785
+ private basePath;
2786
+ private coinTransform;
2787
+ constructor(http: HttpClient, basePath?: string, coinTransform?: (s: string) => string);
2788
+ /** TWAP statuses for a single spot pair. */
2789
+ bySymbol(symbol: string, params: CursorPaginationParams): Promise<CursorResponse<SpotTwapStatus[]>>;
2790
+ /** TWAP statuses for a single user wallet across every spot pair. */
2791
+ byUser(user: string, params: CursorPaginationParams): Promise<CursorResponse<SpotTwapStatus[]>>;
2792
+ }
2793
+
2391
2794
  /**
2392
2795
  * Hyperliquid exchange client
2393
2796
  *
@@ -2445,6 +2848,10 @@ declare class HyperliquidClient {
2445
2848
  * HIP-3 builder-deployed perpetuals (February 2026+)
2446
2849
  */
2447
2850
  readonly hip3: Hip3Client;
2851
+ /**
2852
+ * HIP-4 outcome markets (binary YES/NO; May 2026+)
2853
+ */
2854
+ readonly hip4: Hip4Client;
2448
2855
  private http;
2449
2856
  constructor(http: HttpClient);
2450
2857
  /**
@@ -2549,6 +2956,222 @@ declare class Hip3Client {
2549
2956
  */
2550
2957
  priceHistory(symbol: string, params: PriceHistoryParams): Promise<CursorResponse<PriceSnapshot[]>>;
2551
2958
  }
2959
+ /**
2960
+ * HIP-4 outcome-market client
2961
+ *
2962
+ * Access Hyperliquid HIP-4 binary outcome markets through the 0xarchive API.
2963
+ *
2964
+ * Coin format: `#<10*outcome_id + side>` (e.g. `#0` is outcome 0 / Yes, `#1` is outcome 0 / No).
2965
+ * The backend accepts both the bare numeric form (`0`, `1`) and the on-chain
2966
+ * `#`-prefixed form (`#0`, `#1`). The SDK URL-encodes coins on the wire so that
2967
+ * the `#`-prefixed form survives transit (`#` is the URL-fragment delimiter and
2968
+ * would otherwise be stripped by `fetch`). Either form works; pass whichever is
2969
+ * convenient.
2970
+ *
2971
+ * `mark_price` (and `midPrice`) for HIP-4 is an implied probability in [0, 1],
2972
+ * not a USD price. HIP-4 markets are fully collateralized so there are no
2973
+ * funding rates, no liquidations, and no candles by design.
2974
+ *
2975
+ * Tier gating mirrors HIP-3: Pro+ for L4 / full orderbook / orders, Build+ for everything else.
2976
+ *
2977
+ * @example
2978
+ * ```typescript
2979
+ * const client = new OxArchive({ apiKey: '...' });
2980
+ *
2981
+ * // Both forms work — the SDK encodes `#` to `%23` on the wire so the
2982
+ * // path makes it through `fetch` intact.
2983
+ * const orderbook = await client.hyperliquid.hip4.getOrderbook('#0');
2984
+ * const orderbookAlt = await client.hyperliquid.hip4.getOrderbook('0');
2985
+ *
2986
+ * // Filter outcomes by slug
2987
+ * const outcomes = await client.hyperliquid.hip4.listOutcomes({ isSettled: false });
2988
+ * const bySlug = await client.hyperliquid.hip4.getOutcomeBySlug('btc-above-78213-may-04-0600');
2989
+ * ```
2990
+ */
2991
+ declare class Hip4Client {
2992
+ /**
2993
+ * HIP-4 per-side instruments (one row per `#N`).
2994
+ */
2995
+ readonly instruments: Hip4InstrumentsResource;
2996
+ /**
2997
+ * HIP-4 per-outcome aggregates (one row per outcome). HIP-4-specific, no HIP-3 analog.
2998
+ */
2999
+ readonly outcomes: Hip4OutcomesResource;
3000
+ /**
3001
+ * L2 orderbook snapshots (Pro+).
3002
+ */
3003
+ readonly orderbook: OrderBookResource;
3004
+ /**
3005
+ * Trade/fill history.
3006
+ */
3007
+ readonly trades: TradesResource;
3008
+ /**
3009
+ * Open interest (per side).
3010
+ */
3011
+ readonly openInterest: OpenInterestResource;
3012
+ /**
3013
+ * Order history, flow, and TP/SL (Pro+).
3014
+ */
3015
+ readonly orders: OrdersResource;
3016
+ /**
3017
+ * L4 orderbook (snapshots, diffs, history).
3018
+ */
3019
+ readonly l4Orderbook: L4OrderBookResource;
3020
+ /**
3021
+ * L2 full-depth orderbook (derived from L4).
3022
+ */
3023
+ readonly l2Orderbook: L2OrderBookResource;
3024
+ private http;
3025
+ constructor(http: HttpClient);
3026
+ /** @internal Encode a HIP-4 coin for use in URL paths. */
3027
+ private encodeCoin;
3028
+ /**
3029
+ * List per-outcome aggregates. `aggregatedOi` is omitted on list responses.
3030
+ */
3031
+ listOutcomes(params?: Hip4ListOutcomesParams): Promise<CursorResponse<Hip4OutcomeAggregate[]>>;
3032
+ /**
3033
+ * Get a single outcome aggregate (includes `aggregatedOi`).
3034
+ */
3035
+ getOutcome(outcomeId: number | string): Promise<Hip4OutcomeAggregate>;
3036
+ /**
3037
+ * Look up an outcome aggregate by slug. Accepts the per-outcome slug
3038
+ * (e.g. `btc-above-78213-may-04-0600`) OR a per-side slug
3039
+ * (e.g. `btc-above-78213-yes-may-04-0600`). Includes `aggregatedOi`.
3040
+ */
3041
+ getOutcomeBySlug(slug: string): Promise<Hip4OutcomeAggregate>;
3042
+ /**
3043
+ * List all per-side instruments (one row per `#N`).
3044
+ */
3045
+ getInstruments(): Promise<Hip4Outcome[]>;
3046
+ /**
3047
+ * Get a single per-side instrument by coin (e.g. `#0`).
3048
+ */
3049
+ getInstrument(coin: string): Promise<Hip4Outcome>;
3050
+ /**
3051
+ * Get current L2 orderbook snapshot for a HIP-4 coin (Pro+).
3052
+ * @param coin Coin string with leading `#` (e.g. `#0`).
3053
+ */
3054
+ getOrderbook(coin: string, params?: GetOrderBookParams): Promise<OrderBook>;
3055
+ /**
3056
+ * Get historical L2 orderbook snapshots for a HIP-4 coin (Pro+).
3057
+ */
3058
+ getOrderbookHistory(coin: string, params: OrderBookHistoryParams): Promise<CursorResponse<OrderBook[]>>;
3059
+ /**
3060
+ * Get historical fills for a HIP-4 coin.
3061
+ */
3062
+ getTrades(coin: string, params: GetTradesCursorParams): Promise<CursorResponse<Trade[]>>;
3063
+ /**
3064
+ * Get most recent N fills for a HIP-4 coin (latest first).
3065
+ */
3066
+ getTradesRecent(coin: string, limit?: number): Promise<Trade[]>;
3067
+ /**
3068
+ * Get per-side open interest history for a HIP-4 coin.
3069
+ * Note: `markPrice` on the response is an implied probability (0..1), not USD.
3070
+ */
3071
+ getOpenInterest(coin: string, params: OpenInterestHistoryParams): Promise<CursorResponse<OpenInterest[]>>;
3072
+ /**
3073
+ * Get current per-side open interest for a HIP-4 coin.
3074
+ * Note: `markPrice` on the response is an implied probability (0..1), not USD.
3075
+ */
3076
+ getOpenInterestCurrent(coin: string): Promise<OpenInterest>;
3077
+ /**
3078
+ * Get combined market summary for a HIP-4 coin.
3079
+ * @param coin Either bare numeric form (`'0'`) or `#`-prefixed form (`'#0'`). The SDK URL-encodes `#` so both work.
3080
+ */
3081
+ getSummary(coin: string): Promise<CoinSummary>;
3082
+ /**
3083
+ * Get per-symbol data freshness across all HIP-4 data types.
3084
+ * @param coin Either bare numeric form (`'0'`) or `#`-prefixed form (`'#0'`). The SDK URL-encodes `#` so both work.
3085
+ */
3086
+ getFreshness(coin: string): Promise<CoinFreshness>;
3087
+ /**
3088
+ * Get mid-price history for a HIP-4 coin.
3089
+ * Note: returned `markPrice`/`midPrice` are probabilities (0..1), not USD.
3090
+ * @param coin Either bare numeric form (`'0'`) or `#`-prefixed form (`'#0'`). The SDK URL-encodes `#` so both work.
3091
+ */
3092
+ getPrices(coin: string, params: PriceHistoryParams): Promise<CursorResponse<PriceSnapshot[]>>;
3093
+ /**
3094
+ * Get order lifecycle events for a HIP-4 coin (Pro+).
3095
+ */
3096
+ getOrderHistory(coin: string, params: OrderHistoryParams): Promise<CursorResponse<any[]>>;
3097
+ /**
3098
+ * Get time-bucketed order-flow aggregates for a HIP-4 coin (Pro+).
3099
+ */
3100
+ getOrderFlow(coin: string, params: OrderFlowParams): Promise<CursorResponse<any[]>>;
3101
+ /**
3102
+ * Get TP/SL orders for a HIP-4 coin (Pro+).
3103
+ */
3104
+ getTpsl(coin: string, params: TpslParams): Promise<CursorResponse<any[]>>;
3105
+ /**
3106
+ * Get full L4 reconstruction (current) for a HIP-4 coin (Pro+).
3107
+ */
3108
+ getL4Orderbook(coin: string, params?: L4OrderBookParams): Promise<any>;
3109
+ /**
3110
+ * Get L4 diffs (event stream) for a HIP-4 coin (Pro+).
3111
+ */
3112
+ getL4Diffs(coin: string, params: CursorPaginationParams): Promise<CursorResponse<any[]>>;
3113
+ /**
3114
+ * Get L4 checkpoint history for a HIP-4 coin (Build+; hard cap limit=10).
3115
+ */
3116
+ getL4History(coin: string, params: CursorPaginationParams): Promise<CursorResponse<any[]>>;
3117
+ }
3118
+ /**
3119
+ * Hyperliquid Spot exchange client.
3120
+ *
3121
+ * Access Hyperliquid Spot data through the 0xarchive API. Symbols are
3122
+ * dashed canonical (`HYPE-USDC`, `PURR-USDC`); the server resolves the
3123
+ * dashed form to Hyperliquid's wire formats (`PURR/USDC`, `@107`)
3124
+ * internally.
3125
+ *
3126
+ * Spot has no funding, no open interest, no liquidations, and no candles
3127
+ * by design (those are perpetual constructs). The SDK intentionally omits
3128
+ * those resources from the spot client.
3129
+ *
3130
+ * Coverage:
3131
+ * - Trades: from 2025-03-22 (HL S3 backfill).
3132
+ * - Orderbook, L4 diffs, L4 orders, TWAP statuses: live from 2026-05-05.
3133
+ *
3134
+ * Tier gating mirrors HIP-3: Pro+ for L4 / order lifecycle, Build+ for
3135
+ * everything else.
3136
+ *
3137
+ * @example
3138
+ * ```typescript
3139
+ * const client = new OxArchive({ apiKey: '0xa_...' });
3140
+ *
3141
+ * const orderbook = await client.spot.orderbook.get('HYPE-USDC');
3142
+ * const recentTrades = await client.spot.trades.recent('HYPE-USDC');
3143
+ * const pairs = await client.spot.pairs.list();
3144
+ *
3145
+ * // L4 (Pro+)
3146
+ * const l4 = await client.spot.l4Orderbook.get('HYPE-USDC');
3147
+ * const diffs = await client.spot.l4Orderbook.diffs('HYPE-USDC', { start, end });
3148
+ *
3149
+ * // TWAP statuses (Build+)
3150
+ * const byUser = await client.spot.twap.byUser('0xabc...', { start, end });
3151
+ * ```
3152
+ */
3153
+ declare class SpotClient {
3154
+ /** Spot pair metadata (one row per dashed symbol). */
3155
+ readonly pairs: SpotPairsResource;
3156
+ /** L2 order book snapshots (live from 2026-05-05). */
3157
+ readonly orderbook: OrderBookResource;
3158
+ /** Trade history (S3 backfill from 2025-03-22, live since). */
3159
+ readonly trades: TradesResource;
3160
+ /** Order lifecycle events (Pro+; live from 2026-05-05). */
3161
+ readonly orders: OrdersResource;
3162
+ /** L4 order book: snapshots, diffs, and checkpoint history. */
3163
+ readonly l4Orderbook: L4OrderBookResource;
3164
+ /** TWAP statuses by symbol or by user wallet (Build+). */
3165
+ readonly twap: SpotTwapResource;
3166
+ private http;
3167
+ constructor(http: HttpClient);
3168
+ /**
3169
+ * Get per-symbol data freshness across all spot data types.
3170
+ *
3171
+ * @param symbol Dashed canonical (e.g. `HYPE-USDC`).
3172
+ */
3173
+ freshness(symbol: string): Promise<CoinFreshness>;
3174
+ }
2552
3175
  /**
2553
3176
  * Lighter.xyz exchange client
2554
3177
  *
@@ -2621,8 +3244,11 @@ declare class LighterClient {
2621
3244
  /**
2622
3245
  * 0xarchive API client
2623
3246
  *
2624
- * Supports multiple exchanges:
3247
+ * Supports these top-level venue APIs:
2625
3248
  * - `client.hyperliquid` - Hyperliquid perpetuals (April 2023+)
3249
+ * - `client.hyperliquid.hip3` - Hyperliquid HIP-3 builder perps under the Hyperliquid namespace
3250
+ * - `client.hyperliquid.hip4` - Hyperliquid HIP-4 outcome markets
3251
+ * - `client.spot` - Hyperliquid Spot (trades from 2025-03-22; orderbook + L4 + TWAP live from 2026-05-05)
2626
3252
  * - `client.lighter` - Lighter.xyz perpetuals
2627
3253
  *
2628
3254
  * @example
@@ -2638,6 +3264,9 @@ declare class LighterClient {
2638
3264
  * // Lighter.xyz data
2639
3265
  * const lighterOrderbook = await client.lighter.orderbook.get('BTC');
2640
3266
  *
3267
+ * // Hyperliquid HIP-3 data
3268
+ * const hip3Orderbook = await client.hyperliquid.hip3.orderbook.get('km:US500');
3269
+ *
2641
3270
  * // Get historical data
2642
3271
  * const history = await client.hyperliquid.orderbook.history('ETH', {
2643
3272
  * start: Date.now() - 86400000,
@@ -2665,6 +3294,12 @@ declare class OxArchive {
2665
3294
  * Lighter.xyz exchange data (August 2025+)
2666
3295
  */
2667
3296
  readonly lighter: LighterClient;
3297
+ /**
3298
+ * Hyperliquid Spot exchange data. Trades backfilled from 2025-03-22;
3299
+ * orderbook, L4, and TWAP statuses live from 2026-05-05. Symbols are
3300
+ * dashed canonical (e.g. `HYPE-USDC`).
3301
+ */
3302
+ readonly spot: SpotClient;
2668
3303
  /**
2669
3304
  * Data quality metrics: status, coverage, incidents, latency, SLA
2670
3305
  */
@@ -2773,7 +3408,9 @@ declare class OxArchiveWs {
2773
3408
  private streamCompleteHandlers;
2774
3409
  private orderbookHandlers;
2775
3410
  private tradesHandlers;
3411
+ private liquidationsHandlers;
2776
3412
  private gapHandlers;
3413
+ private outcomeSettledHandlers;
2777
3414
  constructor(options: WsOptions);
2778
3415
  /**
2779
3416
  * Connect to the WebSocket server
@@ -2830,6 +3467,47 @@ declare class OxArchiveWs {
2830
3467
  * Unsubscribe from all tickers
2831
3468
  */
2832
3469
  unsubscribeAllTickers(): void;
3470
+ /**
3471
+ * Subscribe to live liquidation events for a coin (Hyperliquid).
3472
+ *
3473
+ * Each message is a fill row with `is_liquidation: true`. Same wire shape as
3474
+ * trades. Live as of v1.6.0 (Hyperliquid + HIP-3 nodes); historical replay
3475
+ * also supported via `replay('liquidations', ...)`.
3476
+ */
3477
+ subscribeLiquidations(coin: string): void;
3478
+ /** Unsubscribe from live liquidation events (Hyperliquid). */
3479
+ unsubscribeLiquidations(coin: string): void;
3480
+ /**
3481
+ * Subscribe to live HIP-3 liquidation events for a coin.
3482
+ * Each message is a fill row with `is_liquidation: true`.
3483
+ */
3484
+ subscribeHip3Liquidations(coin: string): void;
3485
+ /** Unsubscribe from live HIP-3 liquidation events. */
3486
+ unsubscribeHip3Liquidations(coin: string): void;
3487
+ /**
3488
+ * Subscribe to a Hyperliquid Spot channel for a given dashed pair.
3489
+ *
3490
+ * @param channel One of `spot_orderbook`, `spot_trades`, `spot_l4_diffs`,
3491
+ * `spot_l4_orders`, `spot_twap`. The short form (e.g. `'orderbook'`) is
3492
+ * also accepted and the `spot_` prefix is added automatically.
3493
+ * @param coin Spot dashed canonical symbol (e.g. `'HYPE-USDC'`).
3494
+ */
3495
+ subscribeSpot(channel: 'orderbook' | 'trades' | 'l4_diffs' | 'l4_orders' | 'twap' | 'spot_orderbook' | 'spot_trades' | 'spot_l4_diffs' | 'spot_l4_orders' | 'spot_twap', coin: string): void;
3496
+ /** Unsubscribe from a Hyperliquid Spot channel for a given dashed pair.
3497
+ * Accepts the short form (`'orderbook'`) or the full form (`'spot_orderbook'`). */
3498
+ unsubscribeSpot(channel: 'orderbook' | 'trades' | 'l4_diffs' | 'l4_orders' | 'twap' | 'spot_orderbook' | 'spot_trades' | 'spot_l4_diffs' | 'spot_l4_orders' | 'spot_twap', coin: string): void;
3499
+ /**
3500
+ * Subscribe to a HIP-4 channel for a given outcome coin.
3501
+ *
3502
+ * @param channel One of `hip4_orderbook`, `hip4_trades`, `hip4_open_interest`,
3503
+ * `hip4_l4_diffs`, `hip4_l4_orders`.
3504
+ * @param coin HIP-4 coin (e.g. `'#0'` or `'0'`). The bare numeric form is
3505
+ * recommended; both are accepted by the backend.
3506
+ */
3507
+ subscribeHip4(channel: 'orderbook' | 'trades' | 'open_interest' | 'l4_diffs' | 'l4_orders' | 'hip4_orderbook' | 'hip4_trades' | 'hip4_open_interest' | 'hip4_l4_diffs' | 'hip4_l4_orders', coin: string): void;
3508
+ /** Unsubscribe from a HIP-4 channel for a given outcome coin. Accepts the
3509
+ * short channel form (`'orderbook'`) or the full form (`'hip4_orderbook'`). */
3510
+ unsubscribeHip4(channel: 'orderbook' | 'trades' | 'open_interest' | 'l4_diffs' | 'l4_orders' | 'hip4_orderbook' | 'hip4_trades' | 'hip4_open_interest' | 'hip4_l4_diffs' | 'hip4_l4_orders', coin: string): void;
2833
3511
  /**
2834
3512
  * Start historical replay with timing preserved
2835
3513
  *
@@ -3055,6 +3733,40 @@ declare class OxArchiveWs {
3055
3733
  * Helper to handle typed trade data
3056
3734
  */
3057
3735
  onTrades(handler: (coin: string, data: Trade[]) => void): void;
3736
+ /**
3737
+ * Helper to handle live liquidation events for both `liquidations` and
3738
+ * `hip3_liquidations` channels. Each item is a fill row with
3739
+ * `is_liquidation: true`, surfaced as a `Trade` (the wire shape matches
3740
+ * trades exactly).
3741
+ *
3742
+ * @param handler Called with the channel, coin, and parsed Trade array.
3743
+ *
3744
+ * @example
3745
+ * ```typescript
3746
+ * ws.onLiquidations((channel, coin, fills) => {
3747
+ * for (const f of fills) {
3748
+ * console.log(`${channel} ${coin} liq: ${f.side} ${f.size}@${f.price}`);
3749
+ * }
3750
+ * });
3751
+ * ws.subscribeLiquidations('BTC');
3752
+ * ws.subscribeHip3Liquidations('hyna:BTC');
3753
+ * ```
3754
+ */
3755
+ onLiquidations(handler: (channel: WsChannel, coin: string, data: Trade[]) => void): void;
3756
+ /**
3757
+ * Handle HIP-4 outcome settlement events. Pushed once per `(outcome_id, side)`
3758
+ * when the outcome flips to settled. After this event the server proactively
3759
+ * unsubscribes the client from every hip4_* subscription on the settled coin —
3760
+ * treat the event as a terminal signal for that coin.
3761
+ *
3762
+ * @example
3763
+ * ```typescript
3764
+ * ws.onOutcomeSettled((coin, outcomeId, side, value, at) => {
3765
+ * console.log(`${coin} (outcome ${outcomeId} side ${side}) settled to ${value} at ${at}`);
3766
+ * });
3767
+ * ```
3768
+ */
3769
+ onOutcomeSettled(handler: (coin: string, outcomeId: number, side: number, settlementValue?: number, settlementAt?: string) => void): void;
3058
3770
  private send;
3059
3771
  private setState;
3060
3772
  private startPing;
@@ -3474,7 +4186,7 @@ declare const OpenInterestSchema: z.ZodObject<{
3474
4186
  impactBidPrice?: string | undefined;
3475
4187
  impactAskPrice?: string | undefined;
3476
4188
  }>;
3477
- declare const LiquidationSideSchema: z.ZodEnum<["B", "S"]>;
4189
+ declare const LiquidationSideSchema: z.ZodEnum<["A", "B"]>;
3478
4190
  declare const LiquidationSchema: z.ZodObject<{
3479
4191
  coin: z.ZodString;
3480
4192
  timestamp: z.ZodString;
@@ -3482,7 +4194,7 @@ declare const LiquidationSchema: z.ZodObject<{
3482
4194
  liquidatorUser: z.ZodString;
3483
4195
  price: z.ZodString;
3484
4196
  size: z.ZodString;
3485
- side: z.ZodEnum<["B", "S"]>;
4197
+ side: z.ZodEnum<["A", "B"]>;
3486
4198
  markPrice: z.ZodOptional<z.ZodString>;
3487
4199
  closedPnl: z.ZodOptional<z.ZodString>;
3488
4200
  direction: z.ZodOptional<z.ZodString>;
@@ -3491,7 +4203,7 @@ declare const LiquidationSchema: z.ZodObject<{
3491
4203
  }, "strip", z.ZodTypeAny, {
3492
4204
  coin: string;
3493
4205
  timestamp: string;
3494
- side: "B" | "S";
4206
+ side: "A" | "B";
3495
4207
  price: string;
3496
4208
  size: string;
3497
4209
  liquidatedUser: string;
@@ -3504,7 +4216,7 @@ declare const LiquidationSchema: z.ZodObject<{
3504
4216
  }, {
3505
4217
  coin: string;
3506
4218
  timestamp: string;
3507
- side: "B" | "S";
4219
+ side: "A" | "B";
3508
4220
  price: string;
3509
4221
  size: string;
3510
4222
  liquidatedUser: string;
@@ -3544,32 +4256,32 @@ declare const CandleSchema: z.ZodObject<{
3544
4256
  quoteVolume?: number | undefined;
3545
4257
  tradeCount?: number | undefined;
3546
4258
  }>;
3547
- declare const WsChannelSchema: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4259
+ declare const WsChannelSchema: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3548
4260
  declare const WsConnectionStateSchema: z.ZodEnum<["connecting", "connected", "disconnected", "reconnecting"]>;
3549
4261
  declare const WsSubscribedSchema: z.ZodObject<{
3550
4262
  type: z.ZodLiteral<"subscribed">;
3551
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4263
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3552
4264
  coin: z.ZodOptional<z.ZodString>;
3553
4265
  }, "strip", z.ZodTypeAny, {
3554
4266
  type: "subscribed";
3555
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4267
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3556
4268
  coin?: string | undefined;
3557
4269
  }, {
3558
4270
  type: "subscribed";
3559
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4271
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3560
4272
  coin?: string | undefined;
3561
4273
  }>;
3562
4274
  declare const WsUnsubscribedSchema: z.ZodObject<{
3563
4275
  type: z.ZodLiteral<"unsubscribed">;
3564
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4276
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3565
4277
  coin: z.ZodOptional<z.ZodString>;
3566
4278
  }, "strip", z.ZodTypeAny, {
3567
4279
  type: "unsubscribed";
3568
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4280
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3569
4281
  coin?: string | undefined;
3570
4282
  }, {
3571
4283
  type: "unsubscribed";
3572
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4284
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3573
4285
  coin?: string | undefined;
3574
4286
  }>;
3575
4287
  declare const WsPongSchema: z.ZodObject<{
@@ -3591,23 +4303,23 @@ declare const WsErrorSchema: z.ZodObject<{
3591
4303
  }>;
3592
4304
  declare const WsDataSchema: z.ZodObject<{
3593
4305
  type: z.ZodLiteral<"data">;
3594
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4306
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3595
4307
  coin: z.ZodString;
3596
4308
  data: z.ZodUnknown;
3597
4309
  }, "strip", z.ZodTypeAny, {
3598
4310
  type: "data";
3599
4311
  coin: string;
3600
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4312
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3601
4313
  data?: unknown;
3602
4314
  }, {
3603
4315
  type: "data";
3604
4316
  coin: string;
3605
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4317
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3606
4318
  data?: unknown;
3607
4319
  }>;
3608
4320
  declare const WsReplayStartedSchema: z.ZodObject<{
3609
4321
  type: z.ZodLiteral<"replay_started">;
3610
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4322
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3611
4323
  coin: z.ZodString;
3612
4324
  start: z.ZodNumber;
3613
4325
  end: z.ZodNumber;
@@ -3615,14 +4327,14 @@ declare const WsReplayStartedSchema: z.ZodObject<{
3615
4327
  }, "strip", z.ZodTypeAny, {
3616
4328
  type: "replay_started";
3617
4329
  coin: string;
3618
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4330
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3619
4331
  start: number;
3620
4332
  end: number;
3621
4333
  speed: number;
3622
4334
  }, {
3623
4335
  type: "replay_started";
3624
4336
  coin: string;
3625
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4337
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3626
4338
  start: number;
3627
4339
  end: number;
3628
4340
  speed: number;
@@ -3649,18 +4361,18 @@ declare const WsReplayResumedSchema: z.ZodObject<{
3649
4361
  }>;
3650
4362
  declare const WsReplayCompletedSchema: z.ZodObject<{
3651
4363
  type: z.ZodLiteral<"replay_completed">;
3652
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4364
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3653
4365
  coin: z.ZodString;
3654
4366
  snapshots_sent: z.ZodNumber;
3655
4367
  }, "strip", z.ZodTypeAny, {
3656
4368
  type: "replay_completed";
3657
4369
  coin: string;
3658
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4370
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3659
4371
  snapshots_sent: number;
3660
4372
  }, {
3661
4373
  type: "replay_completed";
3662
4374
  coin: string;
3663
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4375
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3664
4376
  snapshots_sent: number;
3665
4377
  }>;
3666
4378
  declare const WsReplayStoppedSchema: z.ZodObject<{
@@ -3672,7 +4384,7 @@ declare const WsReplayStoppedSchema: z.ZodObject<{
3672
4384
  }>;
3673
4385
  declare const WsHistoricalDataSchema: z.ZodObject<{
3674
4386
  type: z.ZodLiteral<"historical_data">;
3675
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4387
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3676
4388
  coin: z.ZodString;
3677
4389
  timestamp: z.ZodNumber;
3678
4390
  data: z.ZodUnknown;
@@ -3680,18 +4392,18 @@ declare const WsHistoricalDataSchema: z.ZodObject<{
3680
4392
  type: "historical_data";
3681
4393
  coin: string;
3682
4394
  timestamp: number;
3683
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4395
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3684
4396
  data?: unknown;
3685
4397
  }, {
3686
4398
  type: "historical_data";
3687
4399
  coin: string;
3688
4400
  timestamp: number;
3689
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4401
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3690
4402
  data?: unknown;
3691
4403
  }>;
3692
4404
  declare const WsReplaySnapshotSchema: z.ZodObject<{
3693
4405
  type: z.ZodLiteral<"replay_snapshot">;
3694
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4406
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3695
4407
  coin: z.ZodString;
3696
4408
  timestamp: z.ZodNumber;
3697
4409
  data: z.ZodUnknown;
@@ -3699,31 +4411,31 @@ declare const WsReplaySnapshotSchema: z.ZodObject<{
3699
4411
  type: "replay_snapshot";
3700
4412
  coin: string;
3701
4413
  timestamp: number;
3702
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4414
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3703
4415
  data?: unknown;
3704
4416
  }, {
3705
4417
  type: "replay_snapshot";
3706
4418
  coin: string;
3707
4419
  timestamp: number;
3708
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4420
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3709
4421
  data?: unknown;
3710
4422
  }>;
3711
4423
  declare const WsStreamStartedSchema: z.ZodObject<{
3712
4424
  type: z.ZodLiteral<"stream_started">;
3713
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4425
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3714
4426
  coin: z.ZodString;
3715
4427
  start: z.ZodNumber;
3716
4428
  end: z.ZodNumber;
3717
4429
  }, "strip", z.ZodTypeAny, {
3718
4430
  type: "stream_started";
3719
4431
  coin: string;
3720
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4432
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3721
4433
  start: number;
3722
4434
  end: number;
3723
4435
  }, {
3724
4436
  type: "stream_started";
3725
4437
  coin: string;
3726
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4438
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3727
4439
  start: number;
3728
4440
  end: number;
3729
4441
  }>;
@@ -3749,7 +4461,7 @@ declare const TimestampedRecordSchema: z.ZodObject<{
3749
4461
  }>;
3750
4462
  declare const WsHistoricalBatchSchema: z.ZodObject<{
3751
4463
  type: z.ZodLiteral<"historical_batch">;
3752
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4464
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3753
4465
  coin: z.ZodString;
3754
4466
  data: z.ZodArray<z.ZodObject<{
3755
4467
  timestamp: z.ZodNumber;
@@ -3768,7 +4480,7 @@ declare const WsHistoricalBatchSchema: z.ZodObject<{
3768
4480
  }[];
3769
4481
  type: "historical_batch";
3770
4482
  coin: string;
3771
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4483
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3772
4484
  }, {
3773
4485
  data: {
3774
4486
  timestamp: number;
@@ -3776,22 +4488,22 @@ declare const WsHistoricalBatchSchema: z.ZodObject<{
3776
4488
  }[];
3777
4489
  type: "historical_batch";
3778
4490
  coin: string;
3779
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4491
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3780
4492
  }>;
3781
4493
  declare const WsStreamCompletedSchema: z.ZodObject<{
3782
4494
  type: z.ZodLiteral<"stream_completed">;
3783
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4495
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3784
4496
  coin: z.ZodString;
3785
4497
  snapshots_sent: z.ZodNumber;
3786
4498
  }, "strip", z.ZodTypeAny, {
3787
4499
  type: "stream_completed";
3788
4500
  coin: string;
3789
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4501
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3790
4502
  snapshots_sent: number;
3791
4503
  }, {
3792
4504
  type: "stream_completed";
3793
4505
  coin: string;
3794
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4506
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3795
4507
  snapshots_sent: number;
3796
4508
  }>;
3797
4509
  declare const WsStreamStoppedSchema: z.ZodObject<{
@@ -3804,29 +4516,56 @@ declare const WsStreamStoppedSchema: z.ZodObject<{
3804
4516
  type: "stream_stopped";
3805
4517
  snapshots_sent: number;
3806
4518
  }>;
4519
+ /**
4520
+ * HIP-4 outcome settlement event. Fired once per `(outcome_id, side)` when the
4521
+ * outcome flips to settled. After delivery the server unsubscribes the client
4522
+ * from every hip4_* subscription on this coin — treat as a terminal signal.
4523
+ */
4524
+ declare const WsOutcomeSettledSchema: z.ZodObject<{
4525
+ type: z.ZodLiteral<"outcome_settled">;
4526
+ coin: z.ZodString;
4527
+ outcome_id: z.ZodNumber;
4528
+ side: z.ZodNumber;
4529
+ settlement_value: z.ZodOptional<z.ZodNumber>;
4530
+ settlement_at: z.ZodOptional<z.ZodString>;
4531
+ }, "strip", z.ZodTypeAny, {
4532
+ type: "outcome_settled";
4533
+ coin: string;
4534
+ side: number;
4535
+ outcome_id: number;
4536
+ settlement_value?: number | undefined;
4537
+ settlement_at?: string | undefined;
4538
+ }, {
4539
+ type: "outcome_settled";
4540
+ coin: string;
4541
+ side: number;
4542
+ outcome_id: number;
4543
+ settlement_value?: number | undefined;
4544
+ settlement_at?: string | undefined;
4545
+ }>;
3807
4546
  declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
3808
4547
  type: z.ZodLiteral<"subscribed">;
3809
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4548
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3810
4549
  coin: z.ZodOptional<z.ZodString>;
3811
4550
  }, "strip", z.ZodTypeAny, {
3812
4551
  type: "subscribed";
3813
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4552
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3814
4553
  coin?: string | undefined;
3815
4554
  }, {
3816
4555
  type: "subscribed";
3817
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4556
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3818
4557
  coin?: string | undefined;
3819
4558
  }>, z.ZodObject<{
3820
4559
  type: z.ZodLiteral<"unsubscribed">;
3821
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4560
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3822
4561
  coin: z.ZodOptional<z.ZodString>;
3823
4562
  }, "strip", z.ZodTypeAny, {
3824
4563
  type: "unsubscribed";
3825
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4564
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3826
4565
  coin?: string | undefined;
3827
4566
  }, {
3828
4567
  type: "unsubscribed";
3829
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4568
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3830
4569
  coin?: string | undefined;
3831
4570
  }>, z.ZodObject<{
3832
4571
  type: z.ZodLiteral<"pong">;
@@ -3845,22 +4584,22 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
3845
4584
  type: "error";
3846
4585
  }>, z.ZodObject<{
3847
4586
  type: z.ZodLiteral<"data">;
3848
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4587
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3849
4588
  coin: z.ZodString;
3850
4589
  data: z.ZodUnknown;
3851
4590
  }, "strip", z.ZodTypeAny, {
3852
4591
  type: "data";
3853
4592
  coin: string;
3854
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4593
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3855
4594
  data?: unknown;
3856
4595
  }, {
3857
4596
  type: "data";
3858
4597
  coin: string;
3859
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4598
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3860
4599
  data?: unknown;
3861
4600
  }>, z.ZodObject<{
3862
4601
  type: z.ZodLiteral<"replay_started">;
3863
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4602
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3864
4603
  coin: z.ZodString;
3865
4604
  start: z.ZodNumber;
3866
4605
  end: z.ZodNumber;
@@ -3868,14 +4607,14 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
3868
4607
  }, "strip", z.ZodTypeAny, {
3869
4608
  type: "replay_started";
3870
4609
  coin: string;
3871
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4610
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3872
4611
  start: number;
3873
4612
  end: number;
3874
4613
  speed: number;
3875
4614
  }, {
3876
4615
  type: "replay_started";
3877
4616
  coin: string;
3878
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4617
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3879
4618
  start: number;
3880
4619
  end: number;
3881
4620
  speed: number;
@@ -3899,18 +4638,18 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
3899
4638
  current_timestamp: number;
3900
4639
  }>, z.ZodObject<{
3901
4640
  type: z.ZodLiteral<"replay_completed">;
3902
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4641
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3903
4642
  coin: z.ZodString;
3904
4643
  snapshots_sent: z.ZodNumber;
3905
4644
  }, "strip", z.ZodTypeAny, {
3906
4645
  type: "replay_completed";
3907
4646
  coin: string;
3908
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4647
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3909
4648
  snapshots_sent: number;
3910
4649
  }, {
3911
4650
  type: "replay_completed";
3912
4651
  coin: string;
3913
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4652
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3914
4653
  snapshots_sent: number;
3915
4654
  }>, z.ZodObject<{
3916
4655
  type: z.ZodLiteral<"replay_stopped">;
@@ -3920,7 +4659,7 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
3920
4659
  type: "replay_stopped";
3921
4660
  }>, z.ZodObject<{
3922
4661
  type: z.ZodLiteral<"replay_snapshot">;
3923
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4662
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3924
4663
  coin: z.ZodString;
3925
4664
  timestamp: z.ZodNumber;
3926
4665
  data: z.ZodUnknown;
@@ -3928,17 +4667,17 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
3928
4667
  type: "replay_snapshot";
3929
4668
  coin: string;
3930
4669
  timestamp: number;
3931
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4670
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3932
4671
  data?: unknown;
3933
4672
  }, {
3934
4673
  type: "replay_snapshot";
3935
4674
  coin: string;
3936
4675
  timestamp: number;
3937
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4676
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3938
4677
  data?: unknown;
3939
4678
  }>, z.ZodObject<{
3940
4679
  type: z.ZodLiteral<"historical_data">;
3941
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4680
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3942
4681
  coin: z.ZodString;
3943
4682
  timestamp: z.ZodNumber;
3944
4683
  data: z.ZodUnknown;
@@ -3946,30 +4685,30 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
3946
4685
  type: "historical_data";
3947
4686
  coin: string;
3948
4687
  timestamp: number;
3949
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4688
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3950
4689
  data?: unknown;
3951
4690
  }, {
3952
4691
  type: "historical_data";
3953
4692
  coin: string;
3954
4693
  timestamp: number;
3955
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4694
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3956
4695
  data?: unknown;
3957
4696
  }>, z.ZodObject<{
3958
4697
  type: z.ZodLiteral<"stream_started">;
3959
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4698
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3960
4699
  coin: z.ZodString;
3961
4700
  start: z.ZodNumber;
3962
4701
  end: z.ZodNumber;
3963
4702
  }, "strip", z.ZodTypeAny, {
3964
4703
  type: "stream_started";
3965
4704
  coin: string;
3966
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4705
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3967
4706
  start: number;
3968
4707
  end: number;
3969
4708
  }, {
3970
4709
  type: "stream_started";
3971
4710
  coin: string;
3972
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4711
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
3973
4712
  start: number;
3974
4713
  end: number;
3975
4714
  }>, z.ZodObject<{
@@ -3983,7 +4722,7 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
3983
4722
  snapshots_sent: number;
3984
4723
  }>, z.ZodObject<{
3985
4724
  type: z.ZodLiteral<"historical_batch">;
3986
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4725
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
3987
4726
  coin: z.ZodString;
3988
4727
  data: z.ZodArray<z.ZodObject<{
3989
4728
  timestamp: z.ZodNumber;
@@ -4002,7 +4741,7 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
4002
4741
  }[];
4003
4742
  type: "historical_batch";
4004
4743
  coin: string;
4005
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4744
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
4006
4745
  }, {
4007
4746
  data: {
4008
4747
  timestamp: number;
@@ -4010,21 +4749,21 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
4010
4749
  }[];
4011
4750
  type: "historical_batch";
4012
4751
  coin: string;
4013
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4752
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
4014
4753
  }>, z.ZodObject<{
4015
4754
  type: z.ZodLiteral<"stream_completed">;
4016
- channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding"]>;
4755
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers", "open_interest", "funding", "lighter_orderbook", "lighter_trades", "lighter_candles", "lighter_open_interest", "lighter_funding", "lighter_l3_orderbook", "hip3_orderbook", "hip3_trades", "hip3_candles", "hip3_open_interest", "hip3_funding", "hip3_liquidations", "hip4_orderbook", "hip4_trades", "hip4_open_interest", "spot_orderbook", "spot_trades", "spot_l4_diffs", "spot_l4_orders", "spot_twap", "l4_diffs", "l4_orders", "hip3_l4_diffs", "hip3_l4_orders", "hip4_l4_diffs", "hip4_l4_orders"]>;
4017
4756
  coin: z.ZodString;
4018
4757
  snapshots_sent: z.ZodNumber;
4019
4758
  }, "strip", z.ZodTypeAny, {
4020
4759
  type: "stream_completed";
4021
4760
  coin: string;
4022
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4761
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
4023
4762
  snapshots_sent: number;
4024
4763
  }, {
4025
4764
  type: "stream_completed";
4026
4765
  coin: string;
4027
- channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding";
4766
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers" | "open_interest" | "funding" | "lighter_orderbook" | "lighter_trades" | "lighter_candles" | "lighter_open_interest" | "lighter_funding" | "lighter_l3_orderbook" | "hip3_orderbook" | "hip3_trades" | "hip3_candles" | "hip3_open_interest" | "hip3_funding" | "hip3_liquidations" | "hip4_orderbook" | "hip4_trades" | "hip4_open_interest" | "spot_orderbook" | "spot_trades" | "spot_l4_diffs" | "spot_l4_orders" | "spot_twap" | "l4_diffs" | "l4_orders" | "hip3_l4_diffs" | "hip3_l4_orders" | "hip4_l4_diffs" | "hip4_l4_orders";
4028
4767
  snapshots_sent: number;
4029
4768
  }>, z.ZodObject<{
4030
4769
  type: z.ZodLiteral<"stream_stopped">;
@@ -4035,6 +4774,27 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
4035
4774
  }, {
4036
4775
  type: "stream_stopped";
4037
4776
  snapshots_sent: number;
4777
+ }>, z.ZodObject<{
4778
+ type: z.ZodLiteral<"outcome_settled">;
4779
+ coin: z.ZodString;
4780
+ outcome_id: z.ZodNumber;
4781
+ side: z.ZodNumber;
4782
+ settlement_value: z.ZodOptional<z.ZodNumber>;
4783
+ settlement_at: z.ZodOptional<z.ZodString>;
4784
+ }, "strip", z.ZodTypeAny, {
4785
+ type: "outcome_settled";
4786
+ coin: string;
4787
+ side: number;
4788
+ outcome_id: number;
4789
+ settlement_value?: number | undefined;
4790
+ settlement_at?: string | undefined;
4791
+ }, {
4792
+ type: "outcome_settled";
4793
+ coin: string;
4794
+ side: number;
4795
+ outcome_id: number;
4796
+ settlement_value?: number | undefined;
4797
+ settlement_at?: string | undefined;
4038
4798
  }>]>;
4039
4799
  declare const OrderBookResponseSchema: z.ZodObject<{
4040
4800
  success: z.ZodBoolean;
@@ -4962,7 +5722,7 @@ declare const LiquidationArrayResponseSchema: z.ZodObject<{
4962
5722
  liquidatorUser: z.ZodString;
4963
5723
  price: z.ZodString;
4964
5724
  size: z.ZodString;
4965
- side: z.ZodEnum<["B", "S"]>;
5725
+ side: z.ZodEnum<["A", "B"]>;
4966
5726
  markPrice: z.ZodOptional<z.ZodString>;
4967
5727
  closedPnl: z.ZodOptional<z.ZodString>;
4968
5728
  direction: z.ZodOptional<z.ZodString>;
@@ -4971,7 +5731,7 @@ declare const LiquidationArrayResponseSchema: z.ZodObject<{
4971
5731
  }, "strip", z.ZodTypeAny, {
4972
5732
  coin: string;
4973
5733
  timestamp: string;
4974
- side: "B" | "S";
5734
+ side: "A" | "B";
4975
5735
  price: string;
4976
5736
  size: string;
4977
5737
  liquidatedUser: string;
@@ -4984,7 +5744,7 @@ declare const LiquidationArrayResponseSchema: z.ZodObject<{
4984
5744
  }, {
4985
5745
  coin: string;
4986
5746
  timestamp: string;
4987
- side: "B" | "S";
5747
+ side: "A" | "B";
4988
5748
  price: string;
4989
5749
  size: string;
4990
5750
  liquidatedUser: string;
@@ -5012,7 +5772,7 @@ declare const LiquidationArrayResponseSchema: z.ZodObject<{
5012
5772
  data: {
5013
5773
  coin: string;
5014
5774
  timestamp: string;
5015
- side: "B" | "S";
5775
+ side: "A" | "B";
5016
5776
  price: string;
5017
5777
  size: string;
5018
5778
  liquidatedUser: string;
@@ -5033,7 +5793,7 @@ declare const LiquidationArrayResponseSchema: z.ZodObject<{
5033
5793
  data: {
5034
5794
  coin: string;
5035
5795
  timestamp: string;
5036
- side: "B" | "S";
5796
+ side: "A" | "B";
5037
5797
  price: string;
5038
5798
  size: string;
5039
5799
  liquidatedUser: string;
@@ -5676,4 +6436,4 @@ type ValidatedCandle = z.infer<typeof CandleSchema>;
5676
6436
  type ValidatedLiquidation = z.infer<typeof LiquidationSchema>;
5677
6437
  type ValidatedWsServerMessage = z.infer<typeof WsServerMessageSchema>;
5678
6438
 
5679
- export { type ApiError, type ApiMeta, ApiMetaSchema, type ApiResponse, ApiResponseSchema, type Candle, CandleArrayResponseSchema, type CandleHistoryParams, type CandleInterval, CandleIntervalSchema, CandleSchema, type ClientOptions, type CoinFreshness, CoinFreshnessResponseSchema, CoinFreshnessSchema, type CoinSummary, CoinSummaryResponseSchema, CoinSummarySchema, type CompletenessMetrics, type CoverageGap, type CoverageResponse, type CursorResponse, type DataCadence, type DataFreshness, type DataTypeCoverage, type DataTypeFreshnessInfo, DataTypeFreshnessInfoSchema, type DataTypeStatus, type ExchangeCoverage, type ExchangeLatency, type ExchangeStatus, type FundingHistoryParams, type FundingRate, FundingRateArrayResponseSchema, FundingRateResponseSchema, FundingRateSchema, type GetOrderBookParams, type GetTradesCursorParams, Hip3Client, type Hip3Instrument, HyperliquidClient, type Incident, type IncidentSeverityValue, type IncidentStatusValue, type IncidentsResponse, type Instrument, InstrumentArrayResponseSchema, InstrumentResponseSchema, InstrumentSchema, type InstrumentType, InstrumentTypeSchema, type L2Level, type L2OrderBookParams, L2OrderBookResource, type L4Checkpoint, type L4Diff, type L4Order, L4OrderBookReconstructor, type LatencyResponse, LighterClient, type LighterGranularity, type LighterInstrument, type Liquidation, LiquidationArrayResponseSchema, type LiquidationHistoryParams, LiquidationSchema, LiquidationSideSchema, type LiquidationVolume, LiquidationVolumeArrayResponseSchema, type LiquidationVolumeParams, LiquidationVolumeSchema, type LiquidationsByUserParams, type ListIncidentsParams, type OiFundingInterval, type OpenInterest, OpenInterestArrayResponseSchema, type OpenInterestHistoryParams, OpenInterestResponseSchema, OpenInterestSchema, type OrderBook, OrderBookArrayResponseSchema, type OrderBookHistoryParams, OrderBookReconstructor, OrderBookResponseSchema, OrderBookSchema, type OrderbookDelta, OxArchive, OxArchiveError, OxArchiveWs, type Pagination, type PriceHistoryParams, type PriceLevel, PriceLevelSchema, type PriceSnapshot, PriceSnapshotArrayResponseSchema, PriceSnapshotSchema, type ReconstructOptions, type ReconstructedOrderBook, type RestApiLatency, type SiweChallenge, type SlaActual, type SlaParams, type SlaResponse, type SlaTargets, type StatusResponse, type SymbolCoverageOptions, type SymbolCoverageResponse, type SymbolDataTypeCoverage, type SystemStatusValue, type TickData, type TickHistoryParams, type Timestamp, type TimestampedRecord, TimestampedRecordSchema, type Trade, TradeArrayResponseSchema, type TradeDirection, TradeDirectionSchema, TradeSchema, type TradeSide, TradeSideSchema, type ValidatedApiMeta, type ValidatedCandle, type ValidatedFundingRate, type ValidatedInstrument, type ValidatedLiquidation, type ValidatedOpenInterest, type ValidatedOrderBook, type ValidatedPriceLevel, type ValidatedTrade, type ValidatedWsServerMessage, type Web3ApiKey, type Web3KeysList, type Web3PaymentRequired, type Web3RevokeResult, type Web3SignupResult, type Web3SubscribeResult, type WebSocketLatency, type WsChannel, WsChannelSchema, type WsClientMessage, type WsConnectionState, WsConnectionStateSchema, type WsData, WsDataSchema, type WsError, WsErrorSchema, type WsEventHandlers, type WsGapDetected, type WsHistoricalBatch, WsHistoricalBatchSchema, type WsHistoricalData, WsHistoricalDataSchema, type WsHistoricalTickData, type WsL4Batch, type WsL4Snapshot, type WsOptions, type WsPing, type WsPong, WsPongSchema, type WsReplay, type WsReplayCompleted, WsReplayCompletedSchema, type WsReplayPause, type WsReplayPaused, WsReplayPausedSchema, type WsReplayResume, type WsReplayResumed, WsReplayResumedSchema, type WsReplaySeek, type WsReplaySnapshot, WsReplaySnapshotSchema, type WsReplayStarted, WsReplayStartedSchema, type WsReplayStop, type WsReplayStopped, WsReplayStoppedSchema, type WsServerMessage, WsServerMessageSchema, type WsStream, type WsStreamCompleted, WsStreamCompletedSchema, type WsStreamProgress, WsStreamProgressSchema, type WsStreamStarted, WsStreamStartedSchema, type WsStreamStop, type WsStreamStopped, WsStreamStoppedSchema, type WsSubscribe, type WsSubscribed, WsSubscribedSchema, type WsUnsubscribe, type WsUnsubscribed, WsUnsubscribedSchema, OxArchive as default, reconstructFinal, reconstructOrderBook };
6439
+ export { type ApiError, type ApiMeta, ApiMetaSchema, type ApiResponse, ApiResponseSchema, type Candle, CandleArrayResponseSchema, type CandleHistoryParams, type CandleInterval, CandleIntervalSchema, CandleSchema, type ClientOptions, type CoinFreshness, CoinFreshnessResponseSchema, CoinFreshnessSchema, type CoinSummary, CoinSummaryResponseSchema, CoinSummarySchema, type CompletenessMetrics, type CoverageGap, type CoverageResponse, type CursorResponse, type DataCadence, type DataFreshness, type DataTypeCoverage, type DataTypeFreshnessInfo, DataTypeFreshnessInfoSchema, type DataTypeStatus, type ExchangeCoverage, type ExchangeLatency, type ExchangeStatus, type FundingHistoryParams, type FundingRate, FundingRateArrayResponseSchema, FundingRateResponseSchema, FundingRateSchema, type GetOrderBookParams, type GetTradesCursorParams, Hip3Client, type Hip3Instrument, type Hip4AggregatedOi, Hip4Client, type Hip4ListOutcomesParams, type Hip4Outcome, type Hip4OutcomeAggregate, type Hip4OutcomeSideSpec, HyperliquidClient, type Incident, type IncidentSeverityValue, type IncidentStatusValue, type IncidentsResponse, type Instrument, InstrumentArrayResponseSchema, InstrumentResponseSchema, InstrumentSchema, type InstrumentType, InstrumentTypeSchema, type L2Level, type L2OrderBookParams, L2OrderBookResource, type L4Checkpoint, type L4Diff, type L4Order, L4OrderBookReconstructor, type LatencyResponse, LighterClient, type LighterGranularity, type LighterInstrument, type Liquidation, LiquidationArrayResponseSchema, type LiquidationHistoryParams, LiquidationSchema, LiquidationSideSchema, type LiquidationVolume, LiquidationVolumeArrayResponseSchema, type LiquidationVolumeParams, LiquidationVolumeSchema, type LiquidationsByUserParams, type ListIncidentsParams, type OiFundingInterval, type OpenInterest, OpenInterestArrayResponseSchema, type OpenInterestHistoryParams, OpenInterestResponseSchema, OpenInterestSchema, type OrderBook, OrderBookArrayResponseSchema, type OrderBookHistoryParams, OrderBookReconstructor, OrderBookResponseSchema, OrderBookSchema, type OrderbookDelta, OxArchive, OxArchiveError, OxArchiveWs, type Pagination, type PriceHistoryParams, type PriceLevel, PriceLevelSchema, type PriceSnapshot, PriceSnapshotArrayResponseSchema, PriceSnapshotSchema, type ReconstructOptions, type ReconstructedOrderBook, type RestApiLatency, type SiweChallenge, type SlaActual, type SlaParams, type SlaResponse, type SlaTargets, SpotClient, type SpotPair, type SpotTwapStatus, type StatusResponse, type SymbolCoverageOptions, type SymbolCoverageResponse, type SymbolDataTypeCoverage, type SystemStatusValue, type TickData, type TickHistoryParams, type Timestamp, type TimestampedRecord, TimestampedRecordSchema, type Trade, TradeArrayResponseSchema, type TradeDirection, TradeDirectionSchema, TradeSchema, type TradeSide, TradeSideSchema, type ValidatedApiMeta, type ValidatedCandle, type ValidatedFundingRate, type ValidatedInstrument, type ValidatedLiquidation, type ValidatedOpenInterest, type ValidatedOrderBook, type ValidatedPriceLevel, type ValidatedTrade, type ValidatedWsServerMessage, type Web3ApiKey, type Web3KeysList, type Web3PaymentRequired, type Web3RevokeResult, type Web3SignupResult, type Web3SubscribeResult, type WebSocketLatency, type WsChannel, WsChannelSchema, type WsClientMessage, type WsConnectionState, WsConnectionStateSchema, type WsData, WsDataSchema, type WsError, WsErrorSchema, type WsEventHandlers, type WsGapDetected, type WsHistoricalBatch, WsHistoricalBatchSchema, type WsHistoricalData, WsHistoricalDataSchema, type WsHistoricalTickData, type WsL4Batch, type WsL4Snapshot, type WsOptions, type WsOutcomeSettled, WsOutcomeSettledSchema, type WsPing, type WsPong, WsPongSchema, type WsReplay, type WsReplayCompleted, WsReplayCompletedSchema, type WsReplayPause, type WsReplayPaused, WsReplayPausedSchema, type WsReplayResume, type WsReplayResumed, WsReplayResumedSchema, type WsReplaySeek, type WsReplaySnapshot, WsReplaySnapshotSchema, type WsReplayStarted, WsReplayStartedSchema, type WsReplayStop, type WsReplayStopped, WsReplayStoppedSchema, type WsServerMessage, WsServerMessageSchema, type WsStream, type WsStreamCompleted, WsStreamCompletedSchema, type WsStreamProgress, WsStreamProgressSchema, type WsStreamStarted, WsStreamStartedSchema, type WsStreamStop, type WsStreamStopped, WsStreamStoppedSchema, type WsSubscribe, type WsSubscribed, WsSubscribedSchema, type WsUnsubscribe, type WsUnsubscribed, WsUnsubscribedSchema, OxArchive as default, reconstructFinal, reconstructOrderBook };