@0xarchive/sdk 0.9.1 → 1.2.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/README.md +296 -111
- package/dist/index.d.mts +446 -64
- package/dist/index.d.ts +446 -64
- package/dist/index.js +468 -84
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +468 -84
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -464,10 +464,11 @@ interface PriceHistoryParams extends CursorPaginationParams {
|
|
|
464
464
|
*
|
|
465
465
|
* - ticker/all_tickers: real-time only
|
|
466
466
|
* - liquidations: historical only (May 2025+)
|
|
467
|
+
* - hip3_liquidations: historical only (Feb 2026+)
|
|
467
468
|
* - open_interest, funding, lighter_open_interest, lighter_funding,
|
|
468
469
|
* hip3_open_interest, hip3_funding: historical only (replay/stream)
|
|
469
470
|
*/
|
|
470
|
-
type WsChannel = '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';
|
|
471
|
+
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';
|
|
471
472
|
/** Subscribe message from client */
|
|
472
473
|
interface WsSubscribe {
|
|
473
474
|
op: 'subscribe';
|
|
@@ -703,8 +704,24 @@ interface WsGapDetected {
|
|
|
703
704
|
/** Gap duration in minutes */
|
|
704
705
|
duration_minutes: number;
|
|
705
706
|
}
|
|
707
|
+
/** L4 snapshot (sent on l4_diffs/hip3_l4_diffs subscription) */
|
|
708
|
+
interface WsL4Snapshot {
|
|
709
|
+
type: 'l4_snapshot';
|
|
710
|
+
channel: WsChannel;
|
|
711
|
+
coin: string;
|
|
712
|
+
last_block_number: number;
|
|
713
|
+
timestamp: number;
|
|
714
|
+
data: any;
|
|
715
|
+
}
|
|
716
|
+
/** L4 batched data (all L4 channels) */
|
|
717
|
+
interface WsL4Batch {
|
|
718
|
+
type: 'l4_batch';
|
|
719
|
+
channel: WsChannel;
|
|
720
|
+
coin: string;
|
|
721
|
+
data: any[];
|
|
722
|
+
}
|
|
706
723
|
/** Server message union type */
|
|
707
|
-
type WsServerMessage = WsSubscribed | WsUnsubscribed | WsPong | WsError | WsData | WsReplayStarted | WsReplayPaused | WsReplayResumed | WsReplayCompleted | WsReplayStopped | WsReplaySnapshot | WsHistoricalData | WsHistoricalTickData | WsStreamStarted | WsStreamProgress | WsHistoricalBatch | WsStreamCompleted | WsStreamStopped | WsGapDetected;
|
|
724
|
+
type WsServerMessage = WsSubscribed | WsUnsubscribed | WsPong | WsError | WsData | WsReplayStarted | WsReplayPaused | WsReplayResumed | WsReplayCompleted | WsReplayStopped | WsReplaySnapshot | WsHistoricalData | WsHistoricalTickData | WsStreamStarted | WsStreamProgress | WsHistoricalBatch | WsStreamCompleted | WsStreamStopped | WsGapDetected | WsL4Snapshot | WsL4Batch;
|
|
708
725
|
/**
|
|
709
726
|
* WebSocket connection options.
|
|
710
727
|
*
|
|
@@ -736,6 +753,77 @@ interface WsEventHandlers {
|
|
|
736
753
|
onMessage?: (message: WsServerMessage) => void;
|
|
737
754
|
onStateChange?: (state: WsConnectionState) => void;
|
|
738
755
|
}
|
|
756
|
+
/** SIWE challenge message returned by the challenge endpoint */
|
|
757
|
+
interface SiweChallenge {
|
|
758
|
+
/** The SIWE message to sign with personal_sign (EIP-191) */
|
|
759
|
+
message: string;
|
|
760
|
+
/** Single-use nonce (expires after 10 minutes) */
|
|
761
|
+
nonce: string;
|
|
762
|
+
}
|
|
763
|
+
/** Result of creating a free-tier account via wallet signature */
|
|
764
|
+
interface Web3SignupResult {
|
|
765
|
+
/** The generated API key */
|
|
766
|
+
apiKey: string;
|
|
767
|
+
/** Account tier (e.g., 'free') */
|
|
768
|
+
tier: string;
|
|
769
|
+
/** The wallet address that owns this key */
|
|
770
|
+
walletAddress: string;
|
|
771
|
+
}
|
|
772
|
+
/** An API key record returned by the keys endpoint */
|
|
773
|
+
interface Web3ApiKey {
|
|
774
|
+
/** Unique key ID (UUID) */
|
|
775
|
+
id: string;
|
|
776
|
+
/** Key name */
|
|
777
|
+
name: string;
|
|
778
|
+
/** First characters of the key for identification */
|
|
779
|
+
keyPrefix: string;
|
|
780
|
+
/** Whether the key is currently active */
|
|
781
|
+
isActive: boolean;
|
|
782
|
+
/** Last usage timestamp (ISO 8601) */
|
|
783
|
+
lastUsedAt?: string;
|
|
784
|
+
/** Creation timestamp (ISO 8601) */
|
|
785
|
+
createdAt: string;
|
|
786
|
+
}
|
|
787
|
+
/** List of API keys for a wallet */
|
|
788
|
+
interface Web3KeysList {
|
|
789
|
+
/** All API keys belonging to this wallet */
|
|
790
|
+
keys: Web3ApiKey[];
|
|
791
|
+
/** The wallet address */
|
|
792
|
+
walletAddress: string;
|
|
793
|
+
}
|
|
794
|
+
/** Result of revoking an API key */
|
|
795
|
+
interface Web3RevokeResult {
|
|
796
|
+
/** Confirmation message */
|
|
797
|
+
message: string;
|
|
798
|
+
/** The wallet address that owned the key */
|
|
799
|
+
walletAddress: string;
|
|
800
|
+
}
|
|
801
|
+
/** x402 payment details returned by subscribe (402 response) */
|
|
802
|
+
interface Web3PaymentRequired {
|
|
803
|
+
/** Amount in smallest unit (e.g., "49000000" for $49 USDC) */
|
|
804
|
+
amount: string;
|
|
805
|
+
/** Payment asset (e.g., "USDC") */
|
|
806
|
+
asset: string;
|
|
807
|
+
/** Blockchain network (e.g., "base") */
|
|
808
|
+
network: string;
|
|
809
|
+
/** Address to send payment to */
|
|
810
|
+
payTo: string;
|
|
811
|
+
/** Token contract address */
|
|
812
|
+
assetAddress: string;
|
|
813
|
+
}
|
|
814
|
+
/** Result of a successful x402 subscription */
|
|
815
|
+
interface Web3SubscribeResult {
|
|
816
|
+
/** The generated API key */
|
|
817
|
+
apiKey: string;
|
|
818
|
+
/** Subscription tier */
|
|
819
|
+
tier: string;
|
|
820
|
+
/** Expiration timestamp (ISO 8601) */
|
|
821
|
+
expiresAt: string;
|
|
822
|
+
/** The wallet address that owns the subscription */
|
|
823
|
+
walletAddress: string;
|
|
824
|
+
/** On-chain transaction hash */
|
|
825
|
+
txHash?: string;
|
|
826
|
+
}
|
|
739
827
|
/**
|
|
740
828
|
* API error response
|
|
741
829
|
*/
|
|
@@ -1051,6 +1139,10 @@ declare class HttpClient {
|
|
|
1051
1139
|
constructor(options: HttpClientOptions);
|
|
1052
1140
|
/** Whether validation is enabled */
|
|
1053
1141
|
get validationEnabled(): boolean;
|
|
1142
|
+
/** Base URL for raw requests (used by web3 subscribe) */
|
|
1143
|
+
getBaseUrl(): string;
|
|
1144
|
+
/** Timeout in ms for raw requests (used by web3 subscribe) */
|
|
1145
|
+
getTimeout(): number;
|
|
1054
1146
|
/**
|
|
1055
1147
|
* Make a GET request to the API
|
|
1056
1148
|
*
|
|
@@ -1059,6 +1151,14 @@ declare class HttpClient {
|
|
|
1059
1151
|
* @param schema - Optional Zod schema for validation (used when validation is enabled)
|
|
1060
1152
|
*/
|
|
1061
1153
|
get<T>(path: string, params?: Record<string, unknown>, schema?: z.ZodType<T>): Promise<T>;
|
|
1154
|
+
/**
|
|
1155
|
+
* Make a POST request to the API
|
|
1156
|
+
*
|
|
1157
|
+
* @param path - API endpoint path
|
|
1158
|
+
* @param body - JSON request body
|
|
1159
|
+
* @param schema - Optional Zod schema for validation (used when validation is enabled)
|
|
1160
|
+
*/
|
|
1161
|
+
post<T>(path: string, body?: Record<string, unknown>, schema?: z.ZodType<T>): Promise<T>;
|
|
1062
1162
|
}
|
|
1063
1163
|
|
|
1064
1164
|
/**
|
|
@@ -1249,17 +1349,17 @@ declare class OrderBookResource {
|
|
|
1249
1349
|
private coinTransform;
|
|
1250
1350
|
constructor(http: HttpClient, basePath?: string, coinTransform?: (coin: string) => string);
|
|
1251
1351
|
/**
|
|
1252
|
-
* Get order book snapshot for a
|
|
1352
|
+
* Get order book snapshot for a symbol
|
|
1253
1353
|
*
|
|
1254
|
-
* @param
|
|
1354
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
1255
1355
|
* @param params - Optional parameters
|
|
1256
1356
|
* @returns Order book snapshot
|
|
1257
1357
|
*/
|
|
1258
|
-
get(
|
|
1358
|
+
get(symbol: string, params?: GetOrderBookParams): Promise<OrderBook>;
|
|
1259
1359
|
/**
|
|
1260
1360
|
* Get historical order book snapshots with cursor-based pagination
|
|
1261
1361
|
*
|
|
1262
|
-
* @param
|
|
1362
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
1263
1363
|
* @param params - Time range and cursor pagination parameters (start and end are required)
|
|
1264
1364
|
* @returns CursorResponse with order book snapshots and nextCursor for pagination
|
|
1265
1365
|
*
|
|
@@ -1283,7 +1383,7 @@ declare class OrderBookResource {
|
|
|
1283
1383
|
* }
|
|
1284
1384
|
* ```
|
|
1285
1385
|
*/
|
|
1286
|
-
history(
|
|
1386
|
+
history(symbol: string, params: OrderBookHistoryParams): Promise<CursorResponse<OrderBook[]>>;
|
|
1287
1387
|
/**
|
|
1288
1388
|
* Get raw tick-level orderbook data (Enterprise tier only).
|
|
1289
1389
|
*
|
|
@@ -1293,7 +1393,7 @@ declare class OrderBookResource {
|
|
|
1293
1393
|
*
|
|
1294
1394
|
* For automatic reconstruction, use `historyReconstructed()` instead.
|
|
1295
1395
|
*
|
|
1296
|
-
* @param
|
|
1396
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
1297
1397
|
* @param params - Time range parameters
|
|
1298
1398
|
* @returns Tick data with checkpoint and deltas
|
|
1299
1399
|
*
|
|
@@ -1313,7 +1413,7 @@ declare class OrderBookResource {
|
|
|
1313
1413
|
* }
|
|
1314
1414
|
* ```
|
|
1315
1415
|
*/
|
|
1316
|
-
historyTick(
|
|
1416
|
+
historyTick(symbol: string, params: TickHistoryParams): Promise<TickData>;
|
|
1317
1417
|
/**
|
|
1318
1418
|
* Get reconstructed tick-level orderbook history (Enterprise tier only).
|
|
1319
1419
|
*
|
|
@@ -1323,7 +1423,7 @@ declare class OrderBookResource {
|
|
|
1323
1423
|
* For large time ranges, consider using `historyTick()` with the
|
|
1324
1424
|
* `OrderBookReconstructor.iterate()` method for memory efficiency.
|
|
1325
1425
|
*
|
|
1326
|
-
* @param
|
|
1426
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
1327
1427
|
* @param params - Time range parameters
|
|
1328
1428
|
* @param options - Reconstruction options
|
|
1329
1429
|
* @returns Array of reconstructed orderbook snapshots
|
|
@@ -1347,7 +1447,7 @@ declare class OrderBookResource {
|
|
|
1347
1447
|
* );
|
|
1348
1448
|
* ```
|
|
1349
1449
|
*/
|
|
1350
|
-
historyReconstructed(
|
|
1450
|
+
historyReconstructed(symbol: string, params: TickHistoryParams, options?: ReconstructOptions): Promise<ReconstructedOrderBook[]>;
|
|
1351
1451
|
/**
|
|
1352
1452
|
* Create a reconstructor for streaming tick-level data.
|
|
1353
1453
|
*
|
|
@@ -1382,7 +1482,7 @@ declare class OrderBookResource {
|
|
|
1382
1482
|
* per API request and yielding reconstructed orderbook snapshots one at a time.
|
|
1383
1483
|
* Memory-efficient for processing large time ranges.
|
|
1384
1484
|
*
|
|
1385
|
-
* @param
|
|
1485
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
1386
1486
|
* @param params - Time range parameters
|
|
1387
1487
|
* @param depth - Maximum price levels to include in output snapshots
|
|
1388
1488
|
* @yields Reconstructed orderbook snapshots
|
|
@@ -1405,7 +1505,7 @@ declare class OrderBookResource {
|
|
|
1405
1505
|
* }
|
|
1406
1506
|
* ```
|
|
1407
1507
|
*/
|
|
1408
|
-
iterateTickHistory(
|
|
1508
|
+
iterateTickHistory(symbol: string, params: TickHistoryParams, depth?: number): AsyncGenerator<ReconstructedOrderBook, void, undefined>;
|
|
1409
1509
|
}
|
|
1410
1510
|
|
|
1411
1511
|
/**
|
|
@@ -1442,12 +1542,12 @@ declare class TradesResource {
|
|
|
1442
1542
|
private coinTransform;
|
|
1443
1543
|
constructor(http: HttpClient, basePath?: string, coinTransform?: (coin: string) => string);
|
|
1444
1544
|
/**
|
|
1445
|
-
* Get trade history for a
|
|
1545
|
+
* Get trade history for a symbol using cursor-based pagination
|
|
1446
1546
|
*
|
|
1447
1547
|
* Uses cursor-based pagination by default, which is more efficient for large datasets.
|
|
1448
1548
|
* Use the `nextCursor` from the response as the `cursor` parameter to get the next page.
|
|
1449
1549
|
*
|
|
1450
|
-
* @param
|
|
1550
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
1451
1551
|
* @param params - Time range and cursor pagination parameters (start and end are required)
|
|
1452
1552
|
* @returns Object with trades array and nextCursor for pagination
|
|
1453
1553
|
*
|
|
@@ -1471,20 +1571,20 @@ declare class TradesResource {
|
|
|
1471
1571
|
* }
|
|
1472
1572
|
* ```
|
|
1473
1573
|
*/
|
|
1474
|
-
list(
|
|
1574
|
+
list(symbol: string, params: GetTradesCursorParams): Promise<CursorResponse<Trade[]>>;
|
|
1475
1575
|
/**
|
|
1476
|
-
* Get most recent trades for a
|
|
1576
|
+
* Get most recent trades for a symbol.
|
|
1477
1577
|
*
|
|
1478
1578
|
* Note: This method is available for Lighter (client.lighter.trades.recent())
|
|
1479
1579
|
* and HIP-3 (client.hyperliquid.hip3.trades.recent()) which have real-time data
|
|
1480
1580
|
* ingestion. Hyperliquid uses hourly backfill so this endpoint is not available
|
|
1481
1581
|
* for Hyperliquid.
|
|
1482
1582
|
*
|
|
1483
|
-
* @param
|
|
1583
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
1484
1584
|
* @param limit - Number of trades to return (default: 100)
|
|
1485
1585
|
* @returns Array of recent trades
|
|
1486
1586
|
*/
|
|
1487
|
-
recent(
|
|
1587
|
+
recent(symbol: string, limit?: number): Promise<Trade[]>;
|
|
1488
1588
|
}
|
|
1489
1589
|
|
|
1490
1590
|
/**
|
|
@@ -1621,20 +1721,20 @@ declare class FundingResource {
|
|
|
1621
1721
|
private coinTransform;
|
|
1622
1722
|
constructor(http: HttpClient, basePath?: string, coinTransform?: (coin: string) => string);
|
|
1623
1723
|
/**
|
|
1624
|
-
* Get funding rate history for a
|
|
1724
|
+
* Get funding rate history for a symbol with cursor-based pagination
|
|
1625
1725
|
*
|
|
1626
|
-
* @param
|
|
1726
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
1627
1727
|
* @param params - Time range and cursor pagination parameters (start and end are required)
|
|
1628
1728
|
* @returns CursorResponse with funding rate records and nextCursor for pagination
|
|
1629
1729
|
*/
|
|
1630
|
-
history(
|
|
1730
|
+
history(symbol: string, params: FundingHistoryParams): Promise<CursorResponse<FundingRate[]>>;
|
|
1631
1731
|
/**
|
|
1632
|
-
* Get current funding rate for a
|
|
1732
|
+
* Get current funding rate for a symbol
|
|
1633
1733
|
*
|
|
1634
|
-
* @param
|
|
1734
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
1635
1735
|
* @returns Current funding rate
|
|
1636
1736
|
*/
|
|
1637
|
-
current(
|
|
1737
|
+
current(symbol: string): Promise<FundingRate>;
|
|
1638
1738
|
}
|
|
1639
1739
|
|
|
1640
1740
|
/**
|
|
@@ -1671,20 +1771,20 @@ declare class OpenInterestResource {
|
|
|
1671
1771
|
private coinTransform;
|
|
1672
1772
|
constructor(http: HttpClient, basePath?: string, coinTransform?: (coin: string) => string);
|
|
1673
1773
|
/**
|
|
1674
|
-
* Get open interest history for a
|
|
1774
|
+
* Get open interest history for a symbol with cursor-based pagination
|
|
1675
1775
|
*
|
|
1676
|
-
* @param
|
|
1776
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
1677
1777
|
* @param params - Time range and cursor pagination parameters (start and end are required)
|
|
1678
1778
|
* @returns CursorResponse with open interest records and nextCursor for pagination
|
|
1679
1779
|
*/
|
|
1680
|
-
history(
|
|
1780
|
+
history(symbol: string, params: OpenInterestHistoryParams): Promise<CursorResponse<OpenInterest[]>>;
|
|
1681
1781
|
/**
|
|
1682
|
-
* Get current open interest for a
|
|
1782
|
+
* Get current open interest for a symbol
|
|
1683
1783
|
*
|
|
1684
|
-
* @param
|
|
1784
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
1685
1785
|
* @returns Current open interest
|
|
1686
1786
|
*/
|
|
1687
|
-
current(
|
|
1787
|
+
current(symbol: string): Promise<OpenInterest>;
|
|
1688
1788
|
}
|
|
1689
1789
|
|
|
1690
1790
|
/**
|
|
@@ -1727,11 +1827,11 @@ declare class CandlesResource {
|
|
|
1727
1827
|
/**
|
|
1728
1828
|
* Get historical OHLCV candle data with cursor-based pagination
|
|
1729
1829
|
*
|
|
1730
|
-
* @param
|
|
1830
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
1731
1831
|
* @param params - Time range, interval, and cursor pagination parameters (start and end are required)
|
|
1732
1832
|
* @returns CursorResponse with candle records and nextCursor for pagination
|
|
1733
1833
|
*/
|
|
1734
|
-
history(
|
|
1834
|
+
history(symbol: string, params: CandleHistoryParams): Promise<CursorResponse<Candle[]>>;
|
|
1735
1835
|
}
|
|
1736
1836
|
|
|
1737
1837
|
/**
|
|
@@ -1772,15 +1872,16 @@ declare class CandlesResource {
|
|
|
1772
1872
|
declare class LiquidationsResource {
|
|
1773
1873
|
private http;
|
|
1774
1874
|
private basePath;
|
|
1775
|
-
|
|
1875
|
+
private coinTransform;
|
|
1876
|
+
constructor(http: HttpClient, basePath?: string, coinTransform?: (coin: string) => string);
|
|
1776
1877
|
/**
|
|
1777
|
-
* Get liquidation history for a
|
|
1878
|
+
* Get liquidation history for a symbol with cursor-based pagination
|
|
1778
1879
|
*
|
|
1779
|
-
* @param
|
|
1880
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
1780
1881
|
* @param params - Time range and cursor pagination parameters (start and end are required)
|
|
1781
1882
|
* @returns CursorResponse with liquidation records and nextCursor for pagination
|
|
1782
1883
|
*/
|
|
1783
|
-
history(
|
|
1884
|
+
history(symbol: string, params: LiquidationHistoryParams): Promise<CursorResponse<Liquidation[]>>;
|
|
1784
1885
|
/**
|
|
1785
1886
|
* Get liquidation history for a specific user
|
|
1786
1887
|
*
|
|
@@ -1799,11 +1900,11 @@ declare class LiquidationsResource {
|
|
|
1799
1900
|
* Returns pre-aggregated data with total/long/short USD volumes per bucket,
|
|
1800
1901
|
* reducing data transfer by 100-1000x compared to individual liquidation records.
|
|
1801
1902
|
*
|
|
1802
|
-
* @param
|
|
1903
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
1803
1904
|
* @param params - Time range, cursor, and interval parameters
|
|
1804
1905
|
* @returns CursorResponse with liquidation volume buckets
|
|
1805
1906
|
*/
|
|
1806
|
-
volume(
|
|
1907
|
+
volume(symbol: string, params: LiquidationVolumeParams): Promise<CursorResponse<LiquidationVolume[]>>;
|
|
1807
1908
|
}
|
|
1808
1909
|
|
|
1809
1910
|
/**
|
|
@@ -1979,6 +2080,259 @@ declare class DataQualityResource {
|
|
|
1979
2080
|
sla(params?: SlaParams): Promise<SlaResponse>;
|
|
1980
2081
|
}
|
|
1981
2082
|
|
|
2083
|
+
/**
|
|
2084
|
+
* Wallet-based authentication: get API keys via SIWE signature.
|
|
2085
|
+
*
|
|
2086
|
+
* No API key is required for these endpoints. Use an Ethereum wallet to
|
|
2087
|
+
* create a free-tier account, list keys, or revoke keys — all programmatically.
|
|
2088
|
+
*
|
|
2089
|
+
* @example
|
|
2090
|
+
* ```typescript
|
|
2091
|
+
* const client = new OxArchive({ apiKey: 'placeholder' });
|
|
2092
|
+
*
|
|
2093
|
+
* // Step 1: Get a challenge
|
|
2094
|
+
* const challenge = await client.web3.challenge('0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18');
|
|
2095
|
+
*
|
|
2096
|
+
* // Step 2: Sign the message with your wallet, then submit
|
|
2097
|
+
* const result = await client.web3.signup(challenge.message, signature);
|
|
2098
|
+
* console.log(`API key: ${result.apiKey}`);
|
|
2099
|
+
* ```
|
|
2100
|
+
*/
|
|
2101
|
+
declare class Web3Resource {
|
|
2102
|
+
private http;
|
|
2103
|
+
constructor(http: HttpClient);
|
|
2104
|
+
/**
|
|
2105
|
+
* Get a SIWE challenge message to sign.
|
|
2106
|
+
*
|
|
2107
|
+
* @param address - Ethereum wallet address
|
|
2108
|
+
* @returns SIWE message and nonce. Sign the message with personal_sign (EIP-191).
|
|
2109
|
+
*/
|
|
2110
|
+
challenge(address: string): Promise<SiweChallenge>;
|
|
2111
|
+
/**
|
|
2112
|
+
* Create a free-tier account and get an API key.
|
|
2113
|
+
*
|
|
2114
|
+
* @param message - The SIWE message from {@link challenge}
|
|
2115
|
+
* @param signature - Hex-encoded signature from personal_sign
|
|
2116
|
+
* @returns API key, tier, and wallet address
|
|
2117
|
+
*/
|
|
2118
|
+
signup(message: string, signature: string): Promise<Web3SignupResult>;
|
|
2119
|
+
/**
|
|
2120
|
+
* List all API keys for the authenticated wallet.
|
|
2121
|
+
*
|
|
2122
|
+
* @param message - The SIWE message from {@link challenge}
|
|
2123
|
+
* @param signature - Hex-encoded signature from personal_sign
|
|
2124
|
+
* @returns List of API keys and wallet address
|
|
2125
|
+
*/
|
|
2126
|
+
listKeys(message: string, signature: string): Promise<Web3KeysList>;
|
|
2127
|
+
/**
|
|
2128
|
+
* Revoke a specific API key.
|
|
2129
|
+
*
|
|
2130
|
+
* @param message - The SIWE message from {@link challenge}
|
|
2131
|
+
* @param signature - Hex-encoded signature from personal_sign
|
|
2132
|
+
* @param keyId - UUID of the key to revoke
|
|
2133
|
+
* @returns Confirmation message and wallet address
|
|
2134
|
+
*/
|
|
2135
|
+
revokeKey(message: string, signature: string, keyId: string): Promise<Web3RevokeResult>;
|
|
2136
|
+
/**
|
|
2137
|
+
* Get pricing info for a paid subscription (x402 flow, step 1).
|
|
2138
|
+
*
|
|
2139
|
+
* Returns the payment details needed to sign a USDC transfer on Base.
|
|
2140
|
+
* After signing, pass the payment signature to {@link subscribe}.
|
|
2141
|
+
*
|
|
2142
|
+
* @param tier - Subscription tier: 'build' ($49/mo) or 'pro' ($199/mo)
|
|
2143
|
+
* @returns Payment details (amount, asset, network, pay-to address)
|
|
2144
|
+
*/
|
|
2145
|
+
subscribeQuote(tier: 'build' | 'pro'): Promise<Web3PaymentRequired>;
|
|
2146
|
+
/**
|
|
2147
|
+
* Complete a paid subscription with a signed x402 payment (step 2).
|
|
2148
|
+
*
|
|
2149
|
+
* Requires a payment signature from signing a USDC transfer (EIP-3009)
|
|
2150
|
+
* for the amount returned by {@link subscribeQuote}.
|
|
2151
|
+
*
|
|
2152
|
+
* @param tier - Subscription tier: 'build' or 'pro'
|
|
2153
|
+
* @param paymentSignature - Signed x402 payment (from EIP-3009 USDC transfer on Base)
|
|
2154
|
+
* @returns API key, tier, expiration, and wallet address
|
|
2155
|
+
*/
|
|
2156
|
+
subscribe(tier: 'build' | 'pro', paymentSignature: string): Promise<Web3SubscribeResult>;
|
|
2157
|
+
}
|
|
2158
|
+
|
|
2159
|
+
interface OrderHistoryParams extends CursorPaginationParams {
|
|
2160
|
+
user?: string;
|
|
2161
|
+
status?: string;
|
|
2162
|
+
order_type?: string;
|
|
2163
|
+
}
|
|
2164
|
+
interface OrderFlowParams {
|
|
2165
|
+
start: number | string;
|
|
2166
|
+
end: number | string;
|
|
2167
|
+
interval?: string;
|
|
2168
|
+
limit?: number;
|
|
2169
|
+
}
|
|
2170
|
+
interface TpslParams extends CursorPaginationParams {
|
|
2171
|
+
user?: string;
|
|
2172
|
+
triggered?: boolean;
|
|
2173
|
+
}
|
|
2174
|
+
/**
|
|
2175
|
+
* Orders API resource
|
|
2176
|
+
*
|
|
2177
|
+
* @example
|
|
2178
|
+
* ```typescript
|
|
2179
|
+
* // Get order history
|
|
2180
|
+
* const result = await client.hyperliquid.orders.history('BTC', {
|
|
2181
|
+
* start: Date.now() - 86400000,
|
|
2182
|
+
* end: Date.now(),
|
|
2183
|
+
* limit: 1000
|
|
2184
|
+
* });
|
|
2185
|
+
*
|
|
2186
|
+
* // Get order flow
|
|
2187
|
+
* const flow = await client.hyperliquid.orders.flow('BTC', {
|
|
2188
|
+
* start: Date.now() - 86400000,
|
|
2189
|
+
* end: Date.now(),
|
|
2190
|
+
* interval: '1h'
|
|
2191
|
+
* });
|
|
2192
|
+
*
|
|
2193
|
+
* // Get TP/SL orders
|
|
2194
|
+
* const tpsl = await client.hyperliquid.orders.tpsl('BTC', {
|
|
2195
|
+
* start: Date.now() - 86400000,
|
|
2196
|
+
* end: Date.now()
|
|
2197
|
+
* });
|
|
2198
|
+
* ```
|
|
2199
|
+
*/
|
|
2200
|
+
declare class OrdersResource {
|
|
2201
|
+
private http;
|
|
2202
|
+
private basePath;
|
|
2203
|
+
private coinTransform;
|
|
2204
|
+
constructor(http: HttpClient, basePath?: string, coinTransform?: (s: string) => string);
|
|
2205
|
+
/**
|
|
2206
|
+
* Get order history for a symbol with cursor-based pagination
|
|
2207
|
+
*
|
|
2208
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
2209
|
+
* @param params - Time range, cursor pagination, and filter parameters
|
|
2210
|
+
* @returns CursorResponse with order records and nextCursor for pagination
|
|
2211
|
+
*/
|
|
2212
|
+
history(symbol: string, params: OrderHistoryParams): Promise<CursorResponse<any[]>>;
|
|
2213
|
+
/**
|
|
2214
|
+
* Get order flow for a symbol
|
|
2215
|
+
*
|
|
2216
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
2217
|
+
* @param params - Time range and interval parameters
|
|
2218
|
+
* @returns CursorResponse with order flow records
|
|
2219
|
+
*/
|
|
2220
|
+
flow(symbol: string, params: OrderFlowParams): Promise<CursorResponse<any[]>>;
|
|
2221
|
+
/**
|
|
2222
|
+
* Get TP/SL orders for a symbol with cursor-based pagination
|
|
2223
|
+
*
|
|
2224
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
2225
|
+
* @param params - Time range, cursor pagination, and filter parameters
|
|
2226
|
+
* @returns CursorResponse with TP/SL order records
|
|
2227
|
+
*/
|
|
2228
|
+
tpsl(symbol: string, params: TpslParams): Promise<CursorResponse<any[]>>;
|
|
2229
|
+
}
|
|
2230
|
+
|
|
2231
|
+
interface L4OrderBookParams {
|
|
2232
|
+
timestamp?: number | string;
|
|
2233
|
+
depth?: number;
|
|
2234
|
+
}
|
|
2235
|
+
/**
|
|
2236
|
+
* L4 Order Book API resource
|
|
2237
|
+
*
|
|
2238
|
+
* Access L4 orderbook snapshots, diffs, and history.
|
|
2239
|
+
*
|
|
2240
|
+
* @example
|
|
2241
|
+
* ```typescript
|
|
2242
|
+
* // Get current L4 orderbook
|
|
2243
|
+
* const orderbook = await client.hyperliquid.l4Orderbook.get('BTC');
|
|
2244
|
+
*
|
|
2245
|
+
* // Get L4 orderbook diffs
|
|
2246
|
+
* const diffs = await client.hyperliquid.l4Orderbook.diffs('BTC', {
|
|
2247
|
+
* start: Date.now() - 86400000,
|
|
2248
|
+
* end: Date.now(),
|
|
2249
|
+
* limit: 1000
|
|
2250
|
+
* });
|
|
2251
|
+
*
|
|
2252
|
+
* // Get L4 orderbook history
|
|
2253
|
+
* const history = await client.hyperliquid.l4Orderbook.history('BTC', {
|
|
2254
|
+
* start: Date.now() - 86400000,
|
|
2255
|
+
* end: Date.now(),
|
|
2256
|
+
* limit: 1000
|
|
2257
|
+
* });
|
|
2258
|
+
* ```
|
|
2259
|
+
*/
|
|
2260
|
+
declare class L4OrderBookResource {
|
|
2261
|
+
private http;
|
|
2262
|
+
private basePath;
|
|
2263
|
+
private coinTransform;
|
|
2264
|
+
constructor(http: HttpClient, basePath?: string, coinTransform?: (s: string) => string);
|
|
2265
|
+
/**
|
|
2266
|
+
* Get L4 order book snapshot for a symbol
|
|
2267
|
+
*
|
|
2268
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
2269
|
+
* @param params - Optional parameters (timestamp, depth)
|
|
2270
|
+
* @returns L4 order book snapshot
|
|
2271
|
+
*/
|
|
2272
|
+
get(symbol: string, params?: L4OrderBookParams): Promise<any>;
|
|
2273
|
+
/**
|
|
2274
|
+
* Get L4 order book diffs with cursor-based pagination
|
|
2275
|
+
*
|
|
2276
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
2277
|
+
* @param params - Time range and cursor pagination parameters
|
|
2278
|
+
* @returns CursorResponse with L4 orderbook diffs and nextCursor for pagination
|
|
2279
|
+
*/
|
|
2280
|
+
diffs(symbol: string, params: CursorPaginationParams): Promise<CursorResponse<any[]>>;
|
|
2281
|
+
/**
|
|
2282
|
+
* Get L4 order book history with cursor-based pagination
|
|
2283
|
+
*
|
|
2284
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
2285
|
+
* @param params - Time range and cursor pagination parameters
|
|
2286
|
+
* @returns CursorResponse with L4 orderbook snapshots and nextCursor for pagination
|
|
2287
|
+
*/
|
|
2288
|
+
history(symbol: string, params: CursorPaginationParams): Promise<CursorResponse<any[]>>;
|
|
2289
|
+
}
|
|
2290
|
+
|
|
2291
|
+
interface L3OrderBookParams {
|
|
2292
|
+
timestamp?: number | string;
|
|
2293
|
+
depth?: number;
|
|
2294
|
+
}
|
|
2295
|
+
/**
|
|
2296
|
+
* L3 Order Book API resource (Lighter only)
|
|
2297
|
+
*
|
|
2298
|
+
* Access L3 orderbook snapshots and history from Lighter.xyz.
|
|
2299
|
+
*
|
|
2300
|
+
* @example
|
|
2301
|
+
* ```typescript
|
|
2302
|
+
* // Get current L3 orderbook
|
|
2303
|
+
* const orderbook = await client.lighter.l3Orderbook.get('BTC');
|
|
2304
|
+
*
|
|
2305
|
+
* // Get L3 orderbook history
|
|
2306
|
+
* const history = await client.lighter.l3Orderbook.history('BTC', {
|
|
2307
|
+
* start: Date.now() - 86400000,
|
|
2308
|
+
* end: Date.now(),
|
|
2309
|
+
* limit: 1000
|
|
2310
|
+
* });
|
|
2311
|
+
* ```
|
|
2312
|
+
*/
|
|
2313
|
+
declare class L3OrderBookResource {
|
|
2314
|
+
private http;
|
|
2315
|
+
private basePath;
|
|
2316
|
+
private coinTransform;
|
|
2317
|
+
constructor(http: HttpClient, basePath?: string, coinTransform?: (s: string) => string);
|
|
2318
|
+
/**
|
|
2319
|
+
* Get L3 order book snapshot for a symbol
|
|
2320
|
+
*
|
|
2321
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
2322
|
+
* @param params - Optional parameters (timestamp, depth)
|
|
2323
|
+
* @returns L3 order book snapshot
|
|
2324
|
+
*/
|
|
2325
|
+
get(symbol: string, params?: L3OrderBookParams): Promise<any>;
|
|
2326
|
+
/**
|
|
2327
|
+
* Get L3 order book history with cursor-based pagination
|
|
2328
|
+
*
|
|
2329
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
2330
|
+
* @param params - Time range and cursor pagination parameters
|
|
2331
|
+
* @returns CursorResponse with L3 orderbook snapshots and nextCursor for pagination
|
|
2332
|
+
*/
|
|
2333
|
+
history(symbol: string, params: CursorPaginationParams): Promise<CursorResponse<any[]>>;
|
|
2334
|
+
}
|
|
2335
|
+
|
|
1982
2336
|
/**
|
|
1983
2337
|
* Hyperliquid exchange client
|
|
1984
2338
|
*
|
|
@@ -2020,6 +2374,14 @@ declare class HyperliquidClient {
|
|
|
2020
2374
|
* Liquidation events (May 2025+)
|
|
2021
2375
|
*/
|
|
2022
2376
|
readonly liquidations: LiquidationsResource;
|
|
2377
|
+
/**
|
|
2378
|
+
* Order history, flow, and TP/SL
|
|
2379
|
+
*/
|
|
2380
|
+
readonly orders: OrdersResource;
|
|
2381
|
+
/**
|
|
2382
|
+
* L4 order book (snapshots, diffs, history)
|
|
2383
|
+
*/
|
|
2384
|
+
readonly l4Orderbook: L4OrderBookResource;
|
|
2023
2385
|
/**
|
|
2024
2386
|
* HIP-3 builder-deployed perpetuals (February 2026+)
|
|
2025
2387
|
*/
|
|
@@ -2027,27 +2389,27 @@ declare class HyperliquidClient {
|
|
|
2027
2389
|
private http;
|
|
2028
2390
|
constructor(http: HttpClient);
|
|
2029
2391
|
/**
|
|
2030
|
-
* Get per-
|
|
2392
|
+
* Get per-symbol data freshness across all data types
|
|
2031
2393
|
*
|
|
2032
|
-
* @param
|
|
2033
|
-
* @returns Per-
|
|
2394
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
2395
|
+
* @returns Per-symbol freshness with last_updated and lag_ms for each data type
|
|
2034
2396
|
*/
|
|
2035
|
-
freshness(
|
|
2397
|
+
freshness(symbol: string): Promise<CoinFreshness>;
|
|
2036
2398
|
/**
|
|
2037
2399
|
* Get combined market summary (price, funding, OI, volume, liquidations) in one call
|
|
2038
2400
|
*
|
|
2039
|
-
* @param
|
|
2401
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
2040
2402
|
* @returns Combined market summary
|
|
2041
2403
|
*/
|
|
2042
|
-
summary(
|
|
2404
|
+
summary(symbol: string): Promise<CoinSummary>;
|
|
2043
2405
|
/**
|
|
2044
2406
|
* Get mark/oracle/mid price history (projected from OI data)
|
|
2045
2407
|
*
|
|
2046
|
-
* @param
|
|
2408
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
2047
2409
|
* @param params - Time range, cursor, and interval parameters
|
|
2048
2410
|
* @returns CursorResponse with price snapshots
|
|
2049
2411
|
*/
|
|
2050
|
-
priceHistory(
|
|
2412
|
+
priceHistory(symbol: string, params: PriceHistoryParams): Promise<CursorResponse<PriceSnapshot[]>>;
|
|
2051
2413
|
}
|
|
2052
2414
|
/**
|
|
2053
2415
|
* HIP-3 builder-deployed perpetuals client
|
|
@@ -2087,30 +2449,42 @@ declare class Hip3Client {
|
|
|
2087
2449
|
* OHLCV candle data
|
|
2088
2450
|
*/
|
|
2089
2451
|
readonly candles: CandlesResource;
|
|
2452
|
+
/**
|
|
2453
|
+
* Liquidation events
|
|
2454
|
+
*/
|
|
2455
|
+
readonly liquidations: LiquidationsResource;
|
|
2456
|
+
/**
|
|
2457
|
+
* Order history, flow, and TP/SL
|
|
2458
|
+
*/
|
|
2459
|
+
readonly orders: OrdersResource;
|
|
2460
|
+
/**
|
|
2461
|
+
* L4 order book (snapshots, diffs, history)
|
|
2462
|
+
*/
|
|
2463
|
+
readonly l4Orderbook: L4OrderBookResource;
|
|
2090
2464
|
private http;
|
|
2091
2465
|
constructor(http: HttpClient);
|
|
2092
2466
|
/**
|
|
2093
|
-
* Get per-
|
|
2467
|
+
* Get per-symbol data freshness across all data types
|
|
2094
2468
|
*
|
|
2095
|
-
* @param
|
|
2096
|
-
* @returns Per-
|
|
2469
|
+
* @param symbol - The symbol (case-sensitive, e.g., 'km:US500')
|
|
2470
|
+
* @returns Per-symbol freshness with last_updated and lag_ms for each data type
|
|
2097
2471
|
*/
|
|
2098
|
-
freshness(
|
|
2472
|
+
freshness(symbol: string): Promise<CoinFreshness>;
|
|
2099
2473
|
/**
|
|
2100
2474
|
* Get combined market summary (price, funding, OI) in one call
|
|
2101
2475
|
*
|
|
2102
|
-
* @param
|
|
2476
|
+
* @param symbol - The symbol (case-sensitive, e.g., 'km:US500')
|
|
2103
2477
|
* @returns Combined market summary
|
|
2104
2478
|
*/
|
|
2105
|
-
summary(
|
|
2479
|
+
summary(symbol: string): Promise<CoinSummary>;
|
|
2106
2480
|
/**
|
|
2107
2481
|
* Get mark/oracle/mid price history (projected from OI data)
|
|
2108
2482
|
*
|
|
2109
|
-
* @param
|
|
2483
|
+
* @param symbol - The symbol (case-sensitive, e.g., 'km:US500')
|
|
2110
2484
|
* @param params - Time range, cursor, and interval parameters
|
|
2111
2485
|
* @returns CursorResponse with price snapshots
|
|
2112
2486
|
*/
|
|
2113
|
-
priceHistory(
|
|
2487
|
+
priceHistory(symbol: string, params: PriceHistoryParams): Promise<CursorResponse<PriceSnapshot[]>>;
|
|
2114
2488
|
}
|
|
2115
2489
|
/**
|
|
2116
2490
|
* Lighter.xyz exchange client
|
|
@@ -2151,30 +2525,34 @@ declare class LighterClient {
|
|
|
2151
2525
|
* OHLCV candle data
|
|
2152
2526
|
*/
|
|
2153
2527
|
readonly candles: CandlesResource;
|
|
2528
|
+
/**
|
|
2529
|
+
* L3 order book (Lighter only)
|
|
2530
|
+
*/
|
|
2531
|
+
readonly l3Orderbook: L3OrderBookResource;
|
|
2154
2532
|
private http;
|
|
2155
2533
|
constructor(http: HttpClient);
|
|
2156
2534
|
/**
|
|
2157
|
-
* Get per-
|
|
2535
|
+
* Get per-symbol data freshness across all data types
|
|
2158
2536
|
*
|
|
2159
|
-
* @param
|
|
2160
|
-
* @returns Per-
|
|
2537
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
2538
|
+
* @returns Per-symbol freshness with last_updated and lag_ms for each data type
|
|
2161
2539
|
*/
|
|
2162
|
-
freshness(
|
|
2540
|
+
freshness(symbol: string): Promise<CoinFreshness>;
|
|
2163
2541
|
/**
|
|
2164
2542
|
* Get combined market summary (price, funding, OI) in one call
|
|
2165
2543
|
*
|
|
2166
|
-
* @param
|
|
2544
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
2167
2545
|
* @returns Combined market summary
|
|
2168
2546
|
*/
|
|
2169
|
-
summary(
|
|
2547
|
+
summary(symbol: string): Promise<CoinSummary>;
|
|
2170
2548
|
/**
|
|
2171
2549
|
* Get mark/oracle price history (projected from OI data)
|
|
2172
2550
|
*
|
|
2173
|
-
* @param
|
|
2551
|
+
* @param symbol - The symbol (e.g., 'BTC', 'ETH')
|
|
2174
2552
|
* @param params - Time range, cursor, and interval parameters
|
|
2175
2553
|
* @returns CursorResponse with price snapshots
|
|
2176
2554
|
*/
|
|
2177
|
-
priceHistory(
|
|
2555
|
+
priceHistory(symbol: string, params: PriceHistoryParams): Promise<CursorResponse<PriceSnapshot[]>>;
|
|
2178
2556
|
}
|
|
2179
2557
|
|
|
2180
2558
|
/**
|
|
@@ -2228,6 +2606,10 @@ declare class OxArchive {
|
|
|
2228
2606
|
* Data quality metrics: status, coverage, incidents, latency, SLA
|
|
2229
2607
|
*/
|
|
2230
2608
|
readonly dataQuality: DataQualityResource;
|
|
2609
|
+
/**
|
|
2610
|
+
* Wallet-based auth: get API keys via SIWE signature
|
|
2611
|
+
*/
|
|
2612
|
+
readonly web3: Web3Resource;
|
|
2231
2613
|
/**
|
|
2232
2614
|
* @deprecated Use client.hyperliquid.orderbook instead
|
|
2233
2615
|
*/
|
|
@@ -5080,4 +5462,4 @@ type ValidatedCandle = z.infer<typeof CandleSchema>;
|
|
|
5080
5462
|
type ValidatedLiquidation = z.infer<typeof LiquidationSchema>;
|
|
5081
5463
|
type ValidatedWsServerMessage = z.infer<typeof WsServerMessageSchema>;
|
|
5082
5464
|
|
|
5083
|
-
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 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 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 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 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 };
|
|
5465
|
+
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 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 };
|