@0xarchive/sdk 0.5.0 → 0.5.2

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
@@ -264,6 +264,47 @@ interface OpenInterest {
264
264
  */
265
265
  interface OpenInterestHistoryParams extends CursorPaginationParams {
266
266
  }
267
+ /**
268
+ * Liquidation event record
269
+ */
270
+ interface Liquidation {
271
+ /** Trading pair symbol */
272
+ coin: string;
273
+ /** Liquidation timestamp (UTC) */
274
+ timestamp: string;
275
+ /** Address of the liquidated user */
276
+ liquidatedUser: string;
277
+ /** Address of the liquidator */
278
+ liquidatorUser: string;
279
+ /** Liquidation execution price */
280
+ price: string;
281
+ /** Liquidation size */
282
+ size: string;
283
+ /** Side: 'B' (buy) or 'S' (sell) */
284
+ side: 'B' | 'S';
285
+ /** Mark price at time of liquidation */
286
+ markPrice?: string;
287
+ /** Realized PnL from the liquidation */
288
+ closedPnl?: string;
289
+ /** Position direction (e.g., 'Open Long', 'Close Short') */
290
+ direction?: string;
291
+ /** Unique trade ID */
292
+ tradeId?: number;
293
+ /** Blockchain transaction hash */
294
+ txHash?: string;
295
+ }
296
+ /**
297
+ * Parameters for getting liquidation history
298
+ */
299
+ interface LiquidationHistoryParams extends CursorPaginationParams {
300
+ }
301
+ /**
302
+ * Parameters for getting liquidations by user
303
+ */
304
+ interface LiquidationsByUserParams extends CursorPaginationParams {
305
+ /** Optional coin filter */
306
+ coin?: string;
307
+ }
267
308
  /** Candle interval for OHLCV data */
268
309
  type CandleInterval = '1m' | '5m' | '15m' | '30m' | '1h' | '4h' | '1d' | '1w';
269
310
  /**
@@ -294,8 +335,8 @@ interface CandleHistoryParams extends CursorPaginationParams {
294
335
  /** Candle interval (default: 1h) */
295
336
  interval?: CandleInterval;
296
337
  }
297
- /** WebSocket channel types. Note: ticker/all_tickers are real-time only. */
298
- type WsChannel = 'orderbook' | 'trades' | 'candles' | 'ticker' | 'all_tickers';
338
+ /** WebSocket channel types. Note: ticker/all_tickers are real-time only. Liquidations is historical only (May 2025+). */
339
+ type WsChannel = 'orderbook' | 'trades' | 'candles' | 'liquidations' | 'ticker' | 'all_tickers';
299
340
  /** Subscribe message from client */
300
341
  interface WsSubscribe {
301
342
  op: 'subscribe';
@@ -325,6 +366,8 @@ interface WsReplay {
325
366
  speed?: number;
326
367
  /** Data resolution for Lighter orderbook ('checkpoint', '30s', '10s', '1s', 'tick') */
327
368
  granularity?: string;
369
+ /** Candle interval for candles channel ('1m', '5m', '15m', '30m', '1h', '4h', '1d', '1w') */
370
+ interval?: string;
328
371
  }
329
372
  /** Replay control messages */
330
373
  interface WsReplayPause {
@@ -353,6 +396,8 @@ interface WsStream {
353
396
  batch_size?: number;
354
397
  /** Data resolution for Lighter orderbook ('checkpoint', '30s', '10s', '1s', 'tick') */
355
398
  granularity?: string;
399
+ /** Candle interval for candles channel ('1m', '5m', '15m', '30m', '1h', '4h', '1d', '1w') */
400
+ interval?: string;
356
401
  }
357
402
  /** Stream control messages */
358
403
  interface WsStreamStop {
@@ -916,6 +961,67 @@ declare class CandlesResource {
916
961
  history(coin: string, params: CandleHistoryParams): Promise<CursorResponse<Candle[]>>;
917
962
  }
918
963
 
964
+ /**
965
+ * Liquidations API resource
966
+ *
967
+ * Retrieve historical liquidation events from Hyperliquid.
968
+ *
969
+ * Note: Liquidation data is available from May 25, 2025 onwards.
970
+ *
971
+ * @example
972
+ * ```typescript
973
+ * // Get recent liquidations for a coin
974
+ * let result = await client.hyperliquid.liquidations.history('BTC', {
975
+ * start: Date.now() - 86400000,
976
+ * end: Date.now(),
977
+ * limit: 1000
978
+ * });
979
+ *
980
+ * // Get all pages
981
+ * const allLiquidations = [...result.data];
982
+ * while (result.nextCursor) {
983
+ * result = await client.hyperliquid.liquidations.history('BTC', {
984
+ * start: Date.now() - 86400000,
985
+ * end: Date.now(),
986
+ * cursor: result.nextCursor,
987
+ * limit: 1000
988
+ * });
989
+ * allLiquidations.push(...result.data);
990
+ * }
991
+ *
992
+ * // Get liquidations for a specific user
993
+ * const userLiquidations = await client.hyperliquid.liquidations.byUser('0x1234...', {
994
+ * start: Date.now() - 86400000 * 7,
995
+ * end: Date.now()
996
+ * });
997
+ * ```
998
+ */
999
+ declare class LiquidationsResource {
1000
+ private http;
1001
+ private basePath;
1002
+ constructor(http: HttpClient, basePath?: string);
1003
+ /**
1004
+ * Get liquidation history for a coin with cursor-based pagination
1005
+ *
1006
+ * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
1007
+ * @param params - Time range and cursor pagination parameters (start and end are required)
1008
+ * @returns CursorResponse with liquidation records and nextCursor for pagination
1009
+ */
1010
+ history(coin: string, params: LiquidationHistoryParams): Promise<CursorResponse<Liquidation[]>>;
1011
+ /**
1012
+ * Get liquidation history for a specific user
1013
+ *
1014
+ * This returns liquidations where the user was either:
1015
+ * - The liquidated party (their position was liquidated)
1016
+ * - The liquidator (they executed the liquidation)
1017
+ *
1018
+ * @param userAddress - User's wallet address (e.g., '0x1234...')
1019
+ * @param params - Time range and cursor pagination parameters (start and end are required)
1020
+ * @returns CursorResponse with liquidation records and nextCursor for pagination
1021
+ */
1022
+ byUser(userAddress: string, params: LiquidationsByUserParams): Promise<CursorResponse<Liquidation[]>>;
1023
+ }
1024
+
919
1025
  /**
920
1026
  * Hyperliquid exchange client
921
1027
  *
@@ -953,6 +1059,10 @@ declare class HyperliquidClient {
953
1059
  * OHLCV candle data
954
1060
  */
955
1061
  readonly candles: CandlesResource;
1062
+ /**
1063
+ * Liquidation events (May 2025+)
1064
+ */
1065
+ readonly liquidations: LiquidationsResource;
956
1066
  constructor(http: HttpClient);
957
1067
  }
958
1068
  /**
@@ -1219,6 +1329,8 @@ declare class OxArchiveWs {
1219
1329
  end?: number;
1220
1330
  speed?: number;
1221
1331
  granularity?: string;
1332
+ /** Candle interval for candles channel (1m, 5m, 15m, 30m, 1h, 4h, 1d, 1w) */
1333
+ interval?: string;
1222
1334
  }): void;
1223
1335
  /**
1224
1336
  * Pause the current replay
@@ -1258,6 +1370,8 @@ declare class OxArchiveWs {
1258
1370
  end: number;
1259
1371
  batchSize?: number;
1260
1372
  granularity?: string;
1373
+ /** Candle interval for candles channel (1m, 5m, 15m, 30m, 1h, 4h, 1d, 1w) */
1374
+ interval?: string;
1261
1375
  }): void;
1262
1376
  /**
1263
1377
  * Stop the current bulk stream
@@ -1618,6 +1732,47 @@ declare const OpenInterestSchema: z.ZodObject<{
1618
1732
  impactBidPrice?: string | undefined;
1619
1733
  impactAskPrice?: string | undefined;
1620
1734
  }>;
1735
+ declare const LiquidationSideSchema: z.ZodEnum<["B", "S"]>;
1736
+ declare const LiquidationSchema: z.ZodObject<{
1737
+ coin: z.ZodString;
1738
+ timestamp: z.ZodString;
1739
+ liquidatedUser: z.ZodString;
1740
+ liquidatorUser: z.ZodString;
1741
+ price: z.ZodString;
1742
+ size: z.ZodString;
1743
+ side: z.ZodEnum<["B", "S"]>;
1744
+ markPrice: z.ZodOptional<z.ZodString>;
1745
+ closedPnl: z.ZodOptional<z.ZodString>;
1746
+ direction: z.ZodOptional<z.ZodString>;
1747
+ tradeId: z.ZodOptional<z.ZodNumber>;
1748
+ txHash: z.ZodOptional<z.ZodString>;
1749
+ }, "strip", z.ZodTypeAny, {
1750
+ coin: string;
1751
+ timestamp: string;
1752
+ side: "B" | "S";
1753
+ price: string;
1754
+ size: string;
1755
+ liquidatedUser: string;
1756
+ liquidatorUser: string;
1757
+ txHash?: string | undefined;
1758
+ tradeId?: number | undefined;
1759
+ closedPnl?: string | undefined;
1760
+ direction?: string | undefined;
1761
+ markPrice?: string | undefined;
1762
+ }, {
1763
+ coin: string;
1764
+ timestamp: string;
1765
+ side: "B" | "S";
1766
+ price: string;
1767
+ size: string;
1768
+ liquidatedUser: string;
1769
+ liquidatorUser: string;
1770
+ txHash?: string | undefined;
1771
+ tradeId?: number | undefined;
1772
+ closedPnl?: string | undefined;
1773
+ direction?: string | undefined;
1774
+ markPrice?: string | undefined;
1775
+ }>;
1621
1776
  declare const CandleIntervalSchema: z.ZodEnum<["1m", "5m", "15m", "30m", "1h", "4h", "1d", "1w"]>;
1622
1777
  declare const CandleSchema: z.ZodObject<{
1623
1778
  timestamp: z.ZodString;
@@ -1647,32 +1802,32 @@ declare const CandleSchema: z.ZodObject<{
1647
1802
  quoteVolume?: number | undefined;
1648
1803
  tradeCount?: number | undefined;
1649
1804
  }>;
1650
- declare const WsChannelSchema: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
1805
+ declare const WsChannelSchema: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
1651
1806
  declare const WsConnectionStateSchema: z.ZodEnum<["connecting", "connected", "disconnected", "reconnecting"]>;
1652
1807
  declare const WsSubscribedSchema: z.ZodObject<{
1653
1808
  type: z.ZodLiteral<"subscribed">;
1654
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
1809
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
1655
1810
  coin: z.ZodOptional<z.ZodString>;
1656
1811
  }, "strip", z.ZodTypeAny, {
1657
1812
  type: "subscribed";
1658
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
1813
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1659
1814
  coin?: string | undefined;
1660
1815
  }, {
1661
1816
  type: "subscribed";
1662
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
1817
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1663
1818
  coin?: string | undefined;
1664
1819
  }>;
1665
1820
  declare const WsUnsubscribedSchema: z.ZodObject<{
1666
1821
  type: z.ZodLiteral<"unsubscribed">;
1667
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
1822
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
1668
1823
  coin: z.ZodOptional<z.ZodString>;
1669
1824
  }, "strip", z.ZodTypeAny, {
1670
1825
  type: "unsubscribed";
1671
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
1826
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1672
1827
  coin?: string | undefined;
1673
1828
  }, {
1674
1829
  type: "unsubscribed";
1675
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
1830
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1676
1831
  coin?: string | undefined;
1677
1832
  }>;
1678
1833
  declare const WsPongSchema: z.ZodObject<{
@@ -1694,23 +1849,23 @@ declare const WsErrorSchema: z.ZodObject<{
1694
1849
  }>;
1695
1850
  declare const WsDataSchema: z.ZodObject<{
1696
1851
  type: z.ZodLiteral<"data">;
1697
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
1852
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
1698
1853
  coin: z.ZodString;
1699
1854
  data: z.ZodUnknown;
1700
1855
  }, "strip", z.ZodTypeAny, {
1701
1856
  type: "data";
1702
1857
  coin: string;
1703
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
1858
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1704
1859
  data?: unknown;
1705
1860
  }, {
1706
1861
  type: "data";
1707
1862
  coin: string;
1708
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
1863
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1709
1864
  data?: unknown;
1710
1865
  }>;
1711
1866
  declare const WsReplayStartedSchema: z.ZodObject<{
1712
1867
  type: z.ZodLiteral<"replay_started">;
1713
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
1868
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
1714
1869
  coin: z.ZodString;
1715
1870
  start: z.ZodNumber;
1716
1871
  end: z.ZodNumber;
@@ -1718,14 +1873,14 @@ declare const WsReplayStartedSchema: z.ZodObject<{
1718
1873
  }, "strip", z.ZodTypeAny, {
1719
1874
  type: "replay_started";
1720
1875
  coin: string;
1721
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
1876
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1722
1877
  start: number;
1723
1878
  end: number;
1724
1879
  speed: number;
1725
1880
  }, {
1726
1881
  type: "replay_started";
1727
1882
  coin: string;
1728
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
1883
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1729
1884
  start: number;
1730
1885
  end: number;
1731
1886
  speed: number;
@@ -1752,18 +1907,18 @@ declare const WsReplayResumedSchema: z.ZodObject<{
1752
1907
  }>;
1753
1908
  declare const WsReplayCompletedSchema: z.ZodObject<{
1754
1909
  type: z.ZodLiteral<"replay_completed">;
1755
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
1910
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
1756
1911
  coin: z.ZodString;
1757
1912
  snapshotsSent: z.ZodNumber;
1758
1913
  }, "strip", z.ZodTypeAny, {
1759
1914
  type: "replay_completed";
1760
1915
  coin: string;
1761
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
1916
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1762
1917
  snapshotsSent: number;
1763
1918
  }, {
1764
1919
  type: "replay_completed";
1765
1920
  coin: string;
1766
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
1921
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1767
1922
  snapshotsSent: number;
1768
1923
  }>;
1769
1924
  declare const WsReplayStoppedSchema: z.ZodObject<{
@@ -1775,7 +1930,7 @@ declare const WsReplayStoppedSchema: z.ZodObject<{
1775
1930
  }>;
1776
1931
  declare const WsHistoricalDataSchema: z.ZodObject<{
1777
1932
  type: z.ZodLiteral<"historical_data">;
1778
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
1933
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
1779
1934
  coin: z.ZodString;
1780
1935
  timestamp: z.ZodNumber;
1781
1936
  data: z.ZodUnknown;
@@ -1783,31 +1938,31 @@ declare const WsHistoricalDataSchema: z.ZodObject<{
1783
1938
  type: "historical_data";
1784
1939
  coin: string;
1785
1940
  timestamp: number;
1786
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
1941
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1787
1942
  data?: unknown;
1788
1943
  }, {
1789
1944
  type: "historical_data";
1790
1945
  coin: string;
1791
1946
  timestamp: number;
1792
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
1947
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1793
1948
  data?: unknown;
1794
1949
  }>;
1795
1950
  declare const WsStreamStartedSchema: z.ZodObject<{
1796
1951
  type: z.ZodLiteral<"stream_started">;
1797
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
1952
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
1798
1953
  coin: z.ZodString;
1799
1954
  start: z.ZodNumber;
1800
1955
  end: z.ZodNumber;
1801
1956
  }, "strip", z.ZodTypeAny, {
1802
1957
  type: "stream_started";
1803
1958
  coin: string;
1804
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
1959
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1805
1960
  start: number;
1806
1961
  end: number;
1807
1962
  }, {
1808
1963
  type: "stream_started";
1809
1964
  coin: string;
1810
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
1965
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1811
1966
  start: number;
1812
1967
  end: number;
1813
1968
  }>;
@@ -1833,7 +1988,7 @@ declare const TimestampedRecordSchema: z.ZodObject<{
1833
1988
  }>;
1834
1989
  declare const WsHistoricalBatchSchema: z.ZodObject<{
1835
1990
  type: z.ZodLiteral<"historical_batch">;
1836
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
1991
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
1837
1992
  coin: z.ZodString;
1838
1993
  data: z.ZodArray<z.ZodObject<{
1839
1994
  timestamp: z.ZodNumber;
@@ -1852,7 +2007,7 @@ declare const WsHistoricalBatchSchema: z.ZodObject<{
1852
2007
  }[];
1853
2008
  type: "historical_batch";
1854
2009
  coin: string;
1855
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2010
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1856
2011
  }, {
1857
2012
  data: {
1858
2013
  timestamp: number;
@@ -1860,22 +2015,22 @@ declare const WsHistoricalBatchSchema: z.ZodObject<{
1860
2015
  }[];
1861
2016
  type: "historical_batch";
1862
2017
  coin: string;
1863
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2018
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1864
2019
  }>;
1865
2020
  declare const WsStreamCompletedSchema: z.ZodObject<{
1866
2021
  type: z.ZodLiteral<"stream_completed">;
1867
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
2022
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
1868
2023
  coin: z.ZodString;
1869
2024
  snapshotsSent: z.ZodNumber;
1870
2025
  }, "strip", z.ZodTypeAny, {
1871
2026
  type: "stream_completed";
1872
2027
  coin: string;
1873
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2028
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1874
2029
  snapshotsSent: number;
1875
2030
  }, {
1876
2031
  type: "stream_completed";
1877
2032
  coin: string;
1878
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2033
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1879
2034
  snapshotsSent: number;
1880
2035
  }>;
1881
2036
  declare const WsStreamStoppedSchema: z.ZodObject<{
@@ -1890,27 +2045,27 @@ declare const WsStreamStoppedSchema: z.ZodObject<{
1890
2045
  }>;
1891
2046
  declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
1892
2047
  type: z.ZodLiteral<"subscribed">;
1893
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
2048
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
1894
2049
  coin: z.ZodOptional<z.ZodString>;
1895
2050
  }, "strip", z.ZodTypeAny, {
1896
2051
  type: "subscribed";
1897
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2052
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1898
2053
  coin?: string | undefined;
1899
2054
  }, {
1900
2055
  type: "subscribed";
1901
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2056
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1902
2057
  coin?: string | undefined;
1903
2058
  }>, z.ZodObject<{
1904
2059
  type: z.ZodLiteral<"unsubscribed">;
1905
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
2060
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
1906
2061
  coin: z.ZodOptional<z.ZodString>;
1907
2062
  }, "strip", z.ZodTypeAny, {
1908
2063
  type: "unsubscribed";
1909
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2064
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1910
2065
  coin?: string | undefined;
1911
2066
  }, {
1912
2067
  type: "unsubscribed";
1913
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2068
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1914
2069
  coin?: string | undefined;
1915
2070
  }>, z.ZodObject<{
1916
2071
  type: z.ZodLiteral<"pong">;
@@ -1929,22 +2084,22 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
1929
2084
  type: "error";
1930
2085
  }>, z.ZodObject<{
1931
2086
  type: z.ZodLiteral<"data">;
1932
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
2087
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
1933
2088
  coin: z.ZodString;
1934
2089
  data: z.ZodUnknown;
1935
2090
  }, "strip", z.ZodTypeAny, {
1936
2091
  type: "data";
1937
2092
  coin: string;
1938
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2093
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1939
2094
  data?: unknown;
1940
2095
  }, {
1941
2096
  type: "data";
1942
2097
  coin: string;
1943
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2098
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1944
2099
  data?: unknown;
1945
2100
  }>, z.ZodObject<{
1946
2101
  type: z.ZodLiteral<"replay_started">;
1947
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
2102
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
1948
2103
  coin: z.ZodString;
1949
2104
  start: z.ZodNumber;
1950
2105
  end: z.ZodNumber;
@@ -1952,14 +2107,14 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
1952
2107
  }, "strip", z.ZodTypeAny, {
1953
2108
  type: "replay_started";
1954
2109
  coin: string;
1955
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2110
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1956
2111
  start: number;
1957
2112
  end: number;
1958
2113
  speed: number;
1959
2114
  }, {
1960
2115
  type: "replay_started";
1961
2116
  coin: string;
1962
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2117
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1963
2118
  start: number;
1964
2119
  end: number;
1965
2120
  speed: number;
@@ -1983,18 +2138,18 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
1983
2138
  currentTimestamp: number;
1984
2139
  }>, z.ZodObject<{
1985
2140
  type: z.ZodLiteral<"replay_completed">;
1986
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
2141
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
1987
2142
  coin: z.ZodString;
1988
2143
  snapshotsSent: z.ZodNumber;
1989
2144
  }, "strip", z.ZodTypeAny, {
1990
2145
  type: "replay_completed";
1991
2146
  coin: string;
1992
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2147
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1993
2148
  snapshotsSent: number;
1994
2149
  }, {
1995
2150
  type: "replay_completed";
1996
2151
  coin: string;
1997
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2152
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
1998
2153
  snapshotsSent: number;
1999
2154
  }>, z.ZodObject<{
2000
2155
  type: z.ZodLiteral<"replay_stopped">;
@@ -2004,7 +2159,7 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
2004
2159
  type: "replay_stopped";
2005
2160
  }>, z.ZodObject<{
2006
2161
  type: z.ZodLiteral<"historical_data">;
2007
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
2162
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
2008
2163
  coin: z.ZodString;
2009
2164
  timestamp: z.ZodNumber;
2010
2165
  data: z.ZodUnknown;
@@ -2012,30 +2167,30 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
2012
2167
  type: "historical_data";
2013
2168
  coin: string;
2014
2169
  timestamp: number;
2015
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2170
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
2016
2171
  data?: unknown;
2017
2172
  }, {
2018
2173
  type: "historical_data";
2019
2174
  coin: string;
2020
2175
  timestamp: number;
2021
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2176
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
2022
2177
  data?: unknown;
2023
2178
  }>, z.ZodObject<{
2024
2179
  type: z.ZodLiteral<"stream_started">;
2025
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
2180
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
2026
2181
  coin: z.ZodString;
2027
2182
  start: z.ZodNumber;
2028
2183
  end: z.ZodNumber;
2029
2184
  }, "strip", z.ZodTypeAny, {
2030
2185
  type: "stream_started";
2031
2186
  coin: string;
2032
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2187
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
2033
2188
  start: number;
2034
2189
  end: number;
2035
2190
  }, {
2036
2191
  type: "stream_started";
2037
2192
  coin: string;
2038
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2193
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
2039
2194
  start: number;
2040
2195
  end: number;
2041
2196
  }>, z.ZodObject<{
@@ -2049,7 +2204,7 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
2049
2204
  snapshotsSent: number;
2050
2205
  }>, z.ZodObject<{
2051
2206
  type: z.ZodLiteral<"historical_batch">;
2052
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
2207
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
2053
2208
  coin: z.ZodString;
2054
2209
  data: z.ZodArray<z.ZodObject<{
2055
2210
  timestamp: z.ZodNumber;
@@ -2068,7 +2223,7 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
2068
2223
  }[];
2069
2224
  type: "historical_batch";
2070
2225
  coin: string;
2071
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2226
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
2072
2227
  }, {
2073
2228
  data: {
2074
2229
  timestamp: number;
@@ -2076,21 +2231,21 @@ declare const WsServerMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
2076
2231
  }[];
2077
2232
  type: "historical_batch";
2078
2233
  coin: string;
2079
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2234
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
2080
2235
  }>, z.ZodObject<{
2081
2236
  type: z.ZodLiteral<"stream_completed">;
2082
- channel: z.ZodEnum<["orderbook", "trades", "candles", "ticker", "all_tickers"]>;
2237
+ channel: z.ZodEnum<["orderbook", "trades", "candles", "liquidations", "ticker", "all_tickers"]>;
2083
2238
  coin: z.ZodString;
2084
2239
  snapshotsSent: z.ZodNumber;
2085
2240
  }, "strip", z.ZodTypeAny, {
2086
2241
  type: "stream_completed";
2087
2242
  coin: string;
2088
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2243
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
2089
2244
  snapshotsSent: number;
2090
2245
  }, {
2091
2246
  type: "stream_completed";
2092
2247
  coin: string;
2093
- channel: "orderbook" | "trades" | "candles" | "ticker" | "all_tickers";
2248
+ channel: "orderbook" | "trades" | "candles" | "liquidations" | "ticker" | "all_tickers";
2094
2249
  snapshotsSent: number;
2095
2250
  }>, z.ZodObject<{
2096
2251
  type: z.ZodLiteral<"stream_stopped">;
@@ -2989,6 +3144,104 @@ declare const CandleArrayResponseSchema: z.ZodObject<{
2989
3144
  nextCursor?: string | undefined;
2990
3145
  };
2991
3146
  }>;
3147
+ declare const LiquidationArrayResponseSchema: z.ZodObject<{
3148
+ success: z.ZodBoolean;
3149
+ data: z.ZodArray<z.ZodObject<{
3150
+ coin: z.ZodString;
3151
+ timestamp: z.ZodString;
3152
+ liquidatedUser: z.ZodString;
3153
+ liquidatorUser: z.ZodString;
3154
+ price: z.ZodString;
3155
+ size: z.ZodString;
3156
+ side: z.ZodEnum<["B", "S"]>;
3157
+ markPrice: z.ZodOptional<z.ZodString>;
3158
+ closedPnl: z.ZodOptional<z.ZodString>;
3159
+ direction: z.ZodOptional<z.ZodString>;
3160
+ tradeId: z.ZodOptional<z.ZodNumber>;
3161
+ txHash: z.ZodOptional<z.ZodString>;
3162
+ }, "strip", z.ZodTypeAny, {
3163
+ coin: string;
3164
+ timestamp: string;
3165
+ side: "B" | "S";
3166
+ price: string;
3167
+ size: string;
3168
+ liquidatedUser: string;
3169
+ liquidatorUser: string;
3170
+ txHash?: string | undefined;
3171
+ tradeId?: number | undefined;
3172
+ closedPnl?: string | undefined;
3173
+ direction?: string | undefined;
3174
+ markPrice?: string | undefined;
3175
+ }, {
3176
+ coin: string;
3177
+ timestamp: string;
3178
+ side: "B" | "S";
3179
+ price: string;
3180
+ size: string;
3181
+ liquidatedUser: string;
3182
+ liquidatorUser: string;
3183
+ txHash?: string | undefined;
3184
+ tradeId?: number | undefined;
3185
+ closedPnl?: string | undefined;
3186
+ direction?: string | undefined;
3187
+ markPrice?: string | undefined;
3188
+ }>, "many">;
3189
+ meta: z.ZodObject<{
3190
+ count: z.ZodNumber;
3191
+ nextCursor: z.ZodOptional<z.ZodString>;
3192
+ requestId: z.ZodString;
3193
+ }, "strip", z.ZodTypeAny, {
3194
+ count: number;
3195
+ requestId: string;
3196
+ nextCursor?: string | undefined;
3197
+ }, {
3198
+ count: number;
3199
+ requestId: string;
3200
+ nextCursor?: string | undefined;
3201
+ }>;
3202
+ }, "strip", z.ZodTypeAny, {
3203
+ data: {
3204
+ coin: string;
3205
+ timestamp: string;
3206
+ side: "B" | "S";
3207
+ price: string;
3208
+ size: string;
3209
+ liquidatedUser: string;
3210
+ liquidatorUser: string;
3211
+ txHash?: string | undefined;
3212
+ tradeId?: number | undefined;
3213
+ closedPnl?: string | undefined;
3214
+ direction?: string | undefined;
3215
+ markPrice?: string | undefined;
3216
+ }[];
3217
+ success: boolean;
3218
+ meta: {
3219
+ count: number;
3220
+ requestId: string;
3221
+ nextCursor?: string | undefined;
3222
+ };
3223
+ }, {
3224
+ data: {
3225
+ coin: string;
3226
+ timestamp: string;
3227
+ side: "B" | "S";
3228
+ price: string;
3229
+ size: string;
3230
+ liquidatedUser: string;
3231
+ liquidatorUser: string;
3232
+ txHash?: string | undefined;
3233
+ tradeId?: number | undefined;
3234
+ closedPnl?: string | undefined;
3235
+ direction?: string | undefined;
3236
+ markPrice?: string | undefined;
3237
+ }[];
3238
+ success: boolean;
3239
+ meta: {
3240
+ count: number;
3241
+ requestId: string;
3242
+ nextCursor?: string | undefined;
3243
+ };
3244
+ }>;
2992
3245
  type ValidatedApiMeta = z.infer<typeof ApiMetaSchema>;
2993
3246
  type ValidatedPriceLevel = z.infer<typeof PriceLevelSchema>;
2994
3247
  type ValidatedOrderBook = z.infer<typeof OrderBookSchema>;
@@ -2997,6 +3250,7 @@ type ValidatedInstrument = z.infer<typeof InstrumentSchema>;
2997
3250
  type ValidatedFundingRate = z.infer<typeof FundingRateSchema>;
2998
3251
  type ValidatedOpenInterest = z.infer<typeof OpenInterestSchema>;
2999
3252
  type ValidatedCandle = z.infer<typeof CandleSchema>;
3253
+ type ValidatedLiquidation = z.infer<typeof LiquidationSchema>;
3000
3254
  type ValidatedWsServerMessage = z.infer<typeof WsServerMessageSchema>;
3001
3255
 
3002
- export { type ApiError, type ApiMeta, ApiMetaSchema, type ApiResponse, ApiResponseSchema, type Candle, CandleArrayResponseSchema, type CandleHistoryParams, type CandleInterval, CandleIntervalSchema, CandleSchema, type ClientOptions, type CursorResponse, type FundingRate, FundingRateArrayResponseSchema, FundingRateResponseSchema, FundingRateSchema, type GetOrderBookParams, type GetTradesCursorParams, HyperliquidClient, type Instrument, InstrumentArrayResponseSchema, InstrumentResponseSchema, InstrumentSchema, type InstrumentType, InstrumentTypeSchema, LighterClient, type LighterGranularity, type LighterInstrument, type OpenInterest, OpenInterestArrayResponseSchema, OpenInterestResponseSchema, OpenInterestSchema, type OrderBook, OrderBookArrayResponseSchema, type OrderBookHistoryParams, OrderBookResponseSchema, OrderBookSchema, OxArchive, OxArchiveError, OxArchiveWs, type PriceLevel, PriceLevelSchema, type Timestamp, type TimestampedRecord, TimestampedRecordSchema, type Trade, TradeArrayResponseSchema, type TradeDirection, TradeDirectionSchema, TradeSchema, type TradeSide, TradeSideSchema, type ValidatedApiMeta, type ValidatedCandle, type ValidatedFundingRate, type ValidatedInstrument, type ValidatedOpenInterest, type ValidatedOrderBook, type ValidatedPriceLevel, type ValidatedTrade, type ValidatedWsServerMessage, type WsChannel, WsChannelSchema, type WsClientMessage, type WsConnectionState, WsConnectionStateSchema, type WsData, WsDataSchema, type WsError, WsErrorSchema, type WsEventHandlers, type WsHistoricalBatch, WsHistoricalBatchSchema, type WsHistoricalData, WsHistoricalDataSchema, 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 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 };
3256
+ export { type ApiError, type ApiMeta, ApiMetaSchema, type ApiResponse, ApiResponseSchema, type Candle, CandleArrayResponseSchema, type CandleHistoryParams, type CandleInterval, CandleIntervalSchema, CandleSchema, type ClientOptions, type CursorResponse, type FundingRate, FundingRateArrayResponseSchema, FundingRateResponseSchema, FundingRateSchema, type GetOrderBookParams, type GetTradesCursorParams, HyperliquidClient, type Instrument, InstrumentArrayResponseSchema, InstrumentResponseSchema, InstrumentSchema, type InstrumentType, InstrumentTypeSchema, LighterClient, type LighterGranularity, type LighterInstrument, type Liquidation, LiquidationArrayResponseSchema, type LiquidationHistoryParams, LiquidationSchema, LiquidationSideSchema, type LiquidationsByUserParams, type OpenInterest, OpenInterestArrayResponseSchema, OpenInterestResponseSchema, OpenInterestSchema, type OrderBook, OrderBookArrayResponseSchema, type OrderBookHistoryParams, OrderBookResponseSchema, OrderBookSchema, OxArchive, OxArchiveError, OxArchiveWs, type PriceLevel, PriceLevelSchema, 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 WsChannel, WsChannelSchema, type WsClientMessage, type WsConnectionState, WsConnectionStateSchema, type WsData, WsDataSchema, type WsError, WsErrorSchema, type WsEventHandlers, type WsHistoricalBatch, WsHistoricalBatchSchema, type WsHistoricalData, WsHistoricalDataSchema, 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 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 };