• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

nktkas / hyperliquid / 20260168111

16 Dec 2025 07:33AM UTC coverage: 95.34% (-1.3%) from 96.688%
20260168111

push

github

nktkas
docs: improve code documentation

661 of 881 branches covered (75.03%)

Branch coverage included in aggregate %.

5 of 5 new or added lines in 2 files covered. (100.0%)

151 existing lines in 17 files now uncovered.

12843 of 13283 relevant lines covered (96.69%)

1103.6 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.94
/src/api/info/client.ts
1
import type { InfoConfig } from "./_methods/_base/types.ts";
2

3
// =============================================================
4
// Methods Imports
5
// =============================================================
6

7
import {
364✔
8
  activeAssetData,
364✔
9
  type ActiveAssetDataParameters,
10
  type ActiveAssetDataResponse,
11
} from "./_methods/activeAssetData.ts";
364✔
12
import {
364✔
13
  alignedQuoteTokenInfo,
364✔
14
  type AlignedQuoteTokenInfoParameters,
15
  type AlignedQuoteTokenInfoResponse,
16
} from "./_methods/alignedQuoteTokenInfo.ts";
364✔
17
import { allMids, type AllMidsParameters, type AllMidsResponse } from "./_methods/allMids.ts";
364✔
18
import { allPerpMetas, type AllPerpMetasResponse } from "./_methods/allPerpMetas.ts";
364✔
19
import { blockDetails, type BlockDetailsParameters, type BlockDetailsResponse } from "./_methods/blockDetails.ts";
364✔
20
import {
364✔
21
  candleSnapshot,
364✔
22
  type CandleSnapshotParameters,
23
  type CandleSnapshotResponse,
24
} from "./_methods/candleSnapshot.ts";
364✔
25
import {
364✔
26
  clearinghouseState,
364✔
27
  type ClearinghouseStateParameters,
28
  type ClearinghouseStateResponse,
29
} from "./_methods/clearinghouseState.ts";
364✔
30
import { delegations, type DelegationsParameters, type DelegationsResponse } from "./_methods/delegations.ts";
364✔
31
import {
364✔
32
  delegatorHistory,
364✔
33
  type DelegatorHistoryParameters,
34
  type DelegatorHistoryResponse,
35
} from "./_methods/delegatorHistory.ts";
364✔
36
import {
364✔
37
  delegatorRewards,
364✔
38
  type DelegatorRewardsParameters,
39
  type DelegatorRewardsResponse,
40
} from "./_methods/delegatorRewards.ts";
364✔
41
import {
364✔
42
  delegatorSummary,
364✔
43
  type DelegatorSummaryParameters,
44
  type DelegatorSummaryResponse,
45
} from "./_methods/delegatorSummary.ts";
364✔
46
import { exchangeStatus, type ExchangeStatusResponse } from "./_methods/exchangeStatus.ts";
364✔
47
import { extraAgents, type ExtraAgentsParameters, type ExtraAgentsResponse } from "./_methods/extraAgents.ts";
364✔
48
import {
364✔
49
  frontendOpenOrders,
364✔
50
  type FrontendOpenOrdersParameters,
51
  type FrontendOpenOrdersResponse,
52
} from "./_methods/frontendOpenOrders.ts";
364✔
53
import {
364✔
54
  fundingHistory,
364✔
55
  type FundingHistoryParameters,
56
  type FundingHistoryResponse,
57
} from "./_methods/fundingHistory.ts";
364✔
58
import { gossipRootIps, type GossipRootIpsResponse } from "./_methods/gossipRootIps.ts";
364✔
59
import {
364✔
60
  historicalOrders,
364✔
61
  type HistoricalOrdersParameters,
62
  type HistoricalOrdersResponse,
63
} from "./_methods/historicalOrders.ts";
364✔
64
import { isVip, type IsVipParameters, type IsVipResponse } from "./_methods/isVip.ts";
364✔
65
import { l2Book, type L2BookParameters, type L2BookResponse } from "./_methods/l2Book.ts";
364✔
66
import { leadingVaults, type LeadingVaultsParameters, type LeadingVaultsResponse } from "./_methods/leadingVaults.ts";
364✔
67
import { legalCheck, type LegalCheckParameters, type LegalCheckResponse } from "./_methods/legalCheck.ts";
364✔
68
import { liquidatable, type LiquidatableResponse } from "./_methods/liquidatable.ts";
364✔
69
import { marginTable, type MarginTableParameters, type MarginTableResponse } from "./_methods/marginTable.ts";
364✔
70
import { maxBuilderFee, type MaxBuilderFeeParameters, type MaxBuilderFeeResponse } from "./_methods/maxBuilderFee.ts";
364✔
71
import { maxMarketOrderNtls, type MaxMarketOrderNtlsResponse } from "./_methods/maxMarketOrderNtls.ts";
364✔
72
import { meta, type MetaParameters, type MetaResponse } from "./_methods/meta.ts";
364✔
73
import {
364✔
74
  metaAndAssetCtxs,
364✔
75
  type MetaAndAssetCtxsParameters,
76
  type MetaAndAssetCtxsResponse,
77
} from "./_methods/metaAndAssetCtxs.ts";
364✔
78
import { openOrders, type OpenOrdersParameters, type OpenOrdersResponse } from "./_methods/openOrders.ts";
364✔
79
import { orderStatus, type OrderStatusParameters, type OrderStatusResponse } from "./_methods/orderStatus.ts";
364✔
80
import { perpDeployAuctionStatus, type PerpDeployAuctionStatusResponse } from "./_methods/perpDeployAuctionStatus.ts";
364✔
81
import { perpDexLimits, type PerpDexLimitsParameters, type PerpDexLimitsResponse } from "./_methods/perpDexLimits.ts";
364✔
82
import { perpDexs, type PerpDexsResponse } from "./_methods/perpDexs.ts";
364✔
83
import { perpDexStatus, type PerpDexStatusParameters, type PerpDexStatusResponse } from "./_methods/perpDexStatus.ts";
364✔
84
import {
364✔
85
  perpsAtOpenInterestCap,
364✔
86
  type PerpsAtOpenInterestCapParameters,
87
  type PerpsAtOpenInterestCapResponse,
88
} from "./_methods/perpsAtOpenInterestCap.ts";
364✔
89
import { portfolio, type PortfolioParameters, type PortfolioResponse } from "./_methods/portfolio.ts";
364✔
90
import { predictedFundings, type PredictedFundingsResponse } from "./_methods/predictedFundings.ts";
364✔
91
import {
364✔
92
  preTransferCheck,
364✔
93
  type PreTransferCheckParameters,
94
  type PreTransferCheckResponse,
95
} from "./_methods/preTransferCheck.ts";
364✔
96
import { recentTrades, type RecentTradesParameters, type RecentTradesResponse } from "./_methods/recentTrades.ts";
364✔
97
import { referral, type ReferralParameters, type ReferralResponse } from "./_methods/referral.ts";
364✔
98
import {
364✔
99
  spotClearinghouseState,
364✔
100
  type SpotClearinghouseStateParameters,
101
  type SpotClearinghouseStateResponse,
102
} from "./_methods/spotClearinghouseState.ts";
364✔
103
import {
364✔
104
  spotDeployState,
364✔
105
  type SpotDeployStateParameters,
106
  type SpotDeployStateResponse,
107
} from "./_methods/spotDeployState.ts";
364✔
108
import { spotMeta, type SpotMetaResponse } from "./_methods/spotMeta.ts";
364✔
109
import { spotMetaAndAssetCtxs, type SpotMetaAndAssetCtxsResponse } from "./_methods/spotMetaAndAssetCtxs.ts";
364✔
110
import {
364✔
111
  spotPairDeployAuctionStatus,
364✔
112
  type SpotPairDeployAuctionStatusResponse,
113
} from "./_methods/spotPairDeployAuctionStatus.ts";
364✔
114
import { subAccounts, type SubAccountsParameters, type SubAccountsResponse } from "./_methods/subAccounts.ts";
364✔
115
import { subAccounts2, type SubAccounts2Parameters, type SubAccounts2Response } from "./_methods/subAccounts2.ts";
364✔
116
import { tokenDetails, type TokenDetailsParameters, type TokenDetailsResponse } from "./_methods/tokenDetails.ts";
364✔
117
import { twapHistory, type TwapHistoryParameters, type TwapHistoryResponse } from "./_methods/twapHistory.ts";
364✔
118
import { txDetails, type TxDetailsParameters, type TxDetailsResponse } from "./_methods/txDetails.ts";
364✔
119
import { userDetails, type UserDetailsParameters, type UserDetailsResponse } from "./_methods/userDetails.ts";
364✔
120
import {
364✔
121
  userDexAbstraction,
364✔
122
  type UserDexAbstractionParameters,
123
  type UserDexAbstractionResponse,
124
} from "./_methods/userDexAbstraction.ts";
364✔
125
import { userFees, type UserFeesParameters, type UserFeesResponse } from "./_methods/userFees.ts";
364✔
126
import { userFills, type UserFillsParameters, type UserFillsResponse } from "./_methods/userFills.ts";
364✔
127
import {
364✔
128
  userFillsByTime,
364✔
129
  type UserFillsByTimeParameters,
130
  type UserFillsByTimeResponse,
131
} from "./_methods/userFillsByTime.ts";
364✔
132
import { userFunding, type UserFundingParameters, type UserFundingResponse } from "./_methods/userFunding.ts";
364✔
133
import {
364✔
134
  userNonFundingLedgerUpdates,
364✔
135
  type UserNonFundingLedgerUpdatesParameters,
136
  type UserNonFundingLedgerUpdatesResponse,
137
} from "./_methods/userNonFundingLedgerUpdates.ts";
364✔
138
import { userRateLimit, type UserRateLimitParameters, type UserRateLimitResponse } from "./_methods/userRateLimit.ts";
364✔
139
import { userRole, type UserRoleParameters, type UserRoleResponse } from "./_methods/userRole.ts";
364✔
140
import {
364✔
141
  userToMultiSigSigners,
364✔
142
  type UserToMultiSigSignersParameters,
143
  type UserToMultiSigSignersResponse,
144
} from "./_methods/userToMultiSigSigners.ts";
364✔
145
import {
364✔
146
  userTwapSliceFills,
364✔
147
  type UserTwapSliceFillsParameters,
148
  type UserTwapSliceFillsResponse,
149
} from "./_methods/userTwapSliceFills.ts";
364✔
150
import {
364✔
151
  userTwapSliceFillsByTime,
364✔
152
  type UserTwapSliceFillsByTimeParameters,
153
  type UserTwapSliceFillsByTimeResponse,
154
} from "./_methods/userTwapSliceFillsByTime.ts";
364✔
155
import {
364✔
156
  userVaultEquities,
364✔
157
  type UserVaultEquitiesParameters,
158
  type UserVaultEquitiesResponse,
159
} from "./_methods/userVaultEquities.ts";
364✔
160
import { validatorL1Votes, type ValidatorL1VotesResponse } from "./_methods/validatorL1Votes.ts";
364✔
161
import { validatorSummaries, type ValidatorSummariesResponse } from "./_methods/validatorSummaries.ts";
364✔
162
import { vaultDetails, type VaultDetailsParameters, type VaultDetailsResponse } from "./_methods/vaultDetails.ts";
364✔
163
import { vaultSummaries, type VaultSummariesResponse } from "./_methods/vaultSummaries.ts";
364✔
164
import { webData2, type WebData2Parameters, type WebData2Response } from "./_methods/webData2.ts";
364✔
165

166
// =============================================================
167
// Client
168
// =============================================================
169

170
/**
171
 * Read-only access to market data, user state, and other public information.
172
 *
173
 * Corresponds to the {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint | Info endpoint}.
174
 */
175
export class InfoClient<C extends InfoConfig = InfoConfig> {
364✔
176
  config_: C;
364✔
177

178
  /**
179
   * Creates an instance of the InfoClient.
180
   *
181
   * @param config - Configuration for Info API requests. See {@link InfoConfig}.
182
   *
183
   * @example
184
   * ```ts
185
   * import * as hl from "@nktkas/hyperliquid";
186
   *
187
   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
188
   *
189
   * const infoClient = new hl.InfoClient({ transport });
190
   * ```
191
   */
192
  constructor(config: C) {
364✔
193
    this.config_ = config;
575✔
194
  }
575✔
195

196
  /** @see {@link activeAssetData} */
197
  activeAssetData(
364✔
198
    params: ActiveAssetDataParameters,
364✔
199
    signal?: AbortSignal,
364✔
200
  ): Promise<ActiveAssetDataResponse> {
364✔
201
    return activeAssetData(this.config_, params, signal);
367✔
202
  }
367✔
203

204
  /** @see {@link alignedQuoteTokenInfo} */
205
  alignedQuoteTokenInfo(
364✔
206
    params: AlignedQuoteTokenInfoParameters,
364✔
207
    signal?: AbortSignal,
364✔
208
  ): Promise<AlignedQuoteTokenInfoResponse> {
364✔
209
    return alignedQuoteTokenInfo(this.config_, params, signal);
366✔
210
  }
366✔
211

212
  /** @see {@link allMids} */
213
  allMids(
214
    params?: AllMidsParameters,
215
    signal?: AbortSignal,
216
  ): Promise<AllMidsResponse>;
217
  allMids(
218
    signal?: AbortSignal,
219
  ): Promise<AllMidsResponse>;
220
  allMids(
364✔
221
    paramsOrSignal?: AllMidsParameters | AbortSignal,
364✔
222
    maybeSignal?: AbortSignal,
364✔
223
  ): Promise<AllMidsResponse> {
364✔
UNCOV
224
    const params = paramsOrSignal instanceof AbortSignal ? {} : paramsOrSignal;
×
225
    const signal = paramsOrSignal instanceof AbortSignal ? paramsOrSignal : maybeSignal;
×
226
    return allMids(this.config_, params, signal);
439✔
227
  }
439✔
228

229
  /** @see {@link allPerpMetas} */
230
  allPerpMetas(
364✔
231
    signal?: AbortSignal,
364✔
232
  ): Promise<AllPerpMetasResponse> {
364✔
233
    return allPerpMetas(this.config_, signal);
366✔
234
  }
366✔
235

236
  /** @see {@link blockDetails} */
237
  blockDetails(
364✔
238
    params: BlockDetailsParameters,
364✔
239
    signal?: AbortSignal,
364✔
240
  ): Promise<BlockDetailsResponse> {
364✔
241
    return blockDetails(this.config_, params, signal);
366✔
242
  }
366✔
243

244
  /** @see {@link candleSnapshot} */
245
  candleSnapshot(
364✔
246
    params: CandleSnapshotParameters,
364✔
247
    signal?: AbortSignal,
364✔
248
  ): Promise<CandleSnapshotResponse> {
364✔
249
    return candleSnapshot(this.config_, params, signal);
366✔
250
  }
366✔
251

252
  /** @see {@link clearinghouseState} */
253
  clearinghouseState(
364✔
254
    params: ClearinghouseStateParameters,
364✔
255
    signal?: AbortSignal,
364✔
256
  ): Promise<ClearinghouseStateResponse> {
364✔
257
    return clearinghouseState(this.config_, params, signal);
458✔
258
  }
458✔
259

260
  /** @see {@link delegations} */
261
  delegations(
364✔
262
    params: DelegationsParameters,
364✔
263
    signal?: AbortSignal,
364✔
264
  ): Promise<DelegationsResponse> {
364✔
265
    return delegations(this.config_, params, signal);
366✔
266
  }
366✔
267

268
  /** @see {@link delegatorHistory} */
269
  delegatorHistory(
364✔
270
    params: DelegatorHistoryParameters,
364✔
271
    signal?: AbortSignal,
364✔
272
  ): Promise<DelegatorHistoryResponse> {
364✔
273
    return delegatorHistory(this.config_, params, signal);
366✔
274
  }
366✔
275

276
  /** @see {@link delegatorRewards} */
277
  delegatorRewards(
364✔
278
    params: DelegatorRewardsParameters,
364✔
279
    signal?: AbortSignal,
364✔
280
  ): Promise<DelegatorRewardsResponse> {
364✔
281
    return delegatorRewards(this.config_, params, signal);
367✔
282
  }
367✔
283

284
  /** @see {@link delegatorSummary} */
285
  delegatorSummary(
364✔
286
    params: DelegatorSummaryParameters,
364✔
287
    signal?: AbortSignal,
364✔
288
  ): Promise<DelegatorSummaryResponse> {
364✔
289
    return delegatorSummary(this.config_, params, signal);
366✔
290
  }
366✔
291

292
  /** @see {@link exchangeStatus} */
293
  exchangeStatus(
364✔
294
    signal?: AbortSignal,
364✔
295
  ): Promise<ExchangeStatusResponse> {
364✔
296
    return exchangeStatus(this.config_, signal);
366✔
297
  }
366✔
298

299
  /** @see {@link extraAgents} */
300
  extraAgents(
364✔
301
    params: ExtraAgentsParameters,
364✔
302
    signal?: AbortSignal,
364✔
303
  ): Promise<ExtraAgentsResponse> {
364✔
304
    return extraAgents(this.config_, params, signal);
366✔
305
  }
366✔
306

307
  /** @see {@link frontendOpenOrders} */
308
  frontendOpenOrders(
364✔
309
    params: FrontendOpenOrdersParameters,
364✔
310
    signal?: AbortSignal,
364✔
311
  ): Promise<FrontendOpenOrdersResponse> {
364✔
312
    return frontendOpenOrders(this.config_, params, signal);
366✔
313
  }
366✔
314

315
  /** @see {@link fundingHistory} */
316
  fundingHistory(
364✔
317
    params: FundingHistoryParameters,
364✔
318
    signal?: AbortSignal,
364✔
319
  ): Promise<FundingHistoryResponse> {
364✔
320
    return fundingHistory(this.config_, params, signal);
366✔
321
  }
366✔
322

323
  /** @see {@link gossipRootIps} */
324
  gossipRootIps(
364✔
325
    signal?: AbortSignal,
364✔
326
  ): Promise<GossipRootIpsResponse> {
364✔
327
    return gossipRootIps(this.config_, signal);
366✔
328
  }
366✔
329

330
  /** @see {@link historicalOrders} */
331
  historicalOrders(
364✔
332
    params: HistoricalOrdersParameters,
364✔
333
    signal?: AbortSignal,
364✔
334
  ): Promise<HistoricalOrdersResponse> {
364✔
335
    return historicalOrders(this.config_, params, signal);
366✔
336
  }
366✔
337

338
  /** @see {@link isVip} */
339
  isVip(
364✔
340
    params: IsVipParameters,
364✔
341
    signal?: AbortSignal,
364✔
342
  ): Promise<IsVipResponse> {
364✔
343
    return isVip(this.config_, params, signal);
366✔
344
  }
366✔
345

346
  /** @see {@link l2Book} */
347
  l2Book(
364✔
348
    params: L2BookParameters,
364✔
349
    signal?: AbortSignal,
364✔
350
  ): Promise<L2BookResponse> {
364✔
351
    return l2Book(this.config_, params, signal);
367✔
352
  }
367✔
353

354
  /** @see {@link leadingVaults} */
355
  leadingVaults(
364✔
356
    params: LeadingVaultsParameters,
364✔
357
    signal?: AbortSignal,
364✔
358
  ): Promise<LeadingVaultsResponse> {
364✔
359
    return leadingVaults(this.config_, params, signal);
366✔
360
  }
366✔
361

362
  /** @see {@link legalCheck} */
363
  legalCheck(
364✔
364
    params: LegalCheckParameters,
364✔
365
    signal?: AbortSignal,
364✔
366
  ): Promise<LegalCheckResponse> {
364✔
367
    return legalCheck(this.config_, params, signal);
366✔
368
  }
366✔
369

370
  /** @see {@link liquidatable} */
371
  liquidatable(
364✔
372
    signal?: AbortSignal,
364✔
373
  ): Promise<LiquidatableResponse> {
364✔
374
    return liquidatable(this.config_, signal);
366✔
375
  }
366✔
376

377
  /** @see {@link marginTable} */
378
  marginTable(
364✔
379
    params: MarginTableParameters,
364✔
380
    signal?: AbortSignal,
364✔
381
  ): Promise<MarginTableResponse> {
364✔
382
    return marginTable(this.config_, params, signal);
366✔
383
  }
366✔
384

385
  /** @see {@link maxBuilderFee} */
386
  maxBuilderFee(
364✔
387
    params: MaxBuilderFeeParameters,
364✔
388
    signal?: AbortSignal,
364✔
389
  ): Promise<MaxBuilderFeeResponse> {
364✔
390
    return maxBuilderFee(this.config_, params, signal);
366✔
391
  }
366✔
392

393
  /** @see {@link maxMarketOrderNtls} */
394
  maxMarketOrderNtls(
364✔
395
    signal?: AbortSignal,
364✔
396
  ): Promise<MaxMarketOrderNtlsResponse> {
364✔
397
    return maxMarketOrderNtls(this.config_, signal);
366✔
398
  }
366✔
399

400
  /** @see {@link meta} */
401
  meta(
402
    params?: MetaParameters,
403
    signal?: AbortSignal,
404
  ): Promise<MetaResponse>;
405
  meta(
406
    signal?: AbortSignal,
407
  ): Promise<MetaResponse>;
408
  meta(
364✔
409
    paramsOrSignal?: MetaParameters | AbortSignal,
364✔
410
    maybeSignal?: AbortSignal,
364✔
411
  ): Promise<MetaResponse> {
364✔
UNCOV
412
    const params = paramsOrSignal instanceof AbortSignal ? {} : paramsOrSignal;
×
UNCOV
413
    const signal = paramsOrSignal instanceof AbortSignal ? paramsOrSignal : maybeSignal;
×
414
    return meta(this.config_, params, signal);
368✔
415
  }
368✔
416

417
  /** @see {@link metaAndAssetCtxs} */
418
  metaAndAssetCtxs(
419
    params?: MetaAndAssetCtxsParameters,
420
    signal?: AbortSignal,
421
  ): Promise<MetaAndAssetCtxsResponse>;
422
  metaAndAssetCtxs(
423
    signal?: AbortSignal,
424
  ): Promise<MetaAndAssetCtxsResponse>;
425
  metaAndAssetCtxs(
364✔
426
    paramsOrSignal?: MetaAndAssetCtxsParameters | AbortSignal,
364✔
427
    maybeSignal?: AbortSignal,
364✔
428
  ): Promise<MetaAndAssetCtxsResponse> {
364✔
UNCOV
429
    const params = paramsOrSignal instanceof AbortSignal ? {} : paramsOrSignal;
×
UNCOV
430
    const signal = paramsOrSignal instanceof AbortSignal ? paramsOrSignal : maybeSignal;
×
431
    return metaAndAssetCtxs(this.config_, params, signal);
368✔
432
  }
368✔
433

434
  /** @see {@link openOrders} */
435
  openOrders(
364✔
436
    params: OpenOrdersParameters,
364✔
437
    signal?: AbortSignal,
364✔
438
  ): Promise<OpenOrdersResponse> {
364✔
439
    return openOrders(this.config_, params, signal);
366✔
440
  }
366✔
441

442
  /** @see {@link orderStatus} */
443
  orderStatus(
364✔
444
    params: OrderStatusParameters,
364✔
445
    signal?: AbortSignal,
364✔
446
  ): Promise<OrderStatusResponse> {
364✔
447
    return orderStatus(this.config_, params, signal);
386✔
448
  }
386✔
449

450
  /** @see {@link perpDeployAuctionStatus} */
451
  perpDeployAuctionStatus(
364✔
452
    signal?: AbortSignal,
364✔
453
  ): Promise<PerpDeployAuctionStatusResponse> {
364✔
454
    return perpDeployAuctionStatus(this.config_, signal);
366✔
455
  }
366✔
456

457
  /** @see {@link perpDexLimits} */
458
  perpDexLimits(
364✔
459
    params: PerpDexLimitsParameters,
364✔
460
    signal?: AbortSignal,
364✔
461
  ): Promise<PerpDexLimitsResponse> {
364✔
462
    return perpDexLimits(this.config_, params, signal);
367✔
463
  }
367✔
464

465
  /** @see {@link perpDexs} */
466
  perpDexs(
364✔
467
    signal?: AbortSignal,
364✔
468
  ): Promise<PerpDexsResponse> {
364✔
469
    return perpDexs(this.config_, signal);
366✔
470
  }
366✔
471

472
  /** @see {@link perpDexStatus} */
473
  perpDexStatus(
364✔
474
    params: PerpDexStatusParameters,
364✔
475
    signal?: AbortSignal,
364✔
476
  ): Promise<PerpDexStatusResponse> {
364✔
477
    return perpDexStatus(this.config_, params, signal);
366✔
478
  }
366✔
479

480
  /** @see {@link perpsAtOpenInterestCap} */
481
  perpsAtOpenInterestCap(
482
    params?: PerpsAtOpenInterestCapParameters,
483
    signal?: AbortSignal,
484
  ): Promise<PerpsAtOpenInterestCapResponse>;
485
  perpsAtOpenInterestCap(
486
    signal?: AbortSignal,
487
  ): Promise<PerpsAtOpenInterestCapResponse>;
488
  perpsAtOpenInterestCap(
364✔
489
    paramsOrSignal?: PerpsAtOpenInterestCapParameters | AbortSignal,
364✔
490
    maybeSignal?: AbortSignal,
364✔
491
  ): Promise<PerpsAtOpenInterestCapResponse> {
364✔
UNCOV
492
    const params = paramsOrSignal instanceof AbortSignal ? {} : paramsOrSignal;
×
UNCOV
493
    const signal = paramsOrSignal instanceof AbortSignal ? paramsOrSignal : maybeSignal;
×
494
    return perpsAtOpenInterestCap(this.config_, params, signal);
366✔
495
  }
366✔
496

497
  /** @see {@link portfolio} */
498
  portfolio(
364✔
499
    params: PortfolioParameters,
364✔
500
    signal?: AbortSignal,
364✔
501
  ): Promise<PortfolioResponse> {
364✔
502
    return portfolio(this.config_, params, signal);
366✔
503
  }
366✔
504

505
  /** @see {@link predictedFundings} */
506
  predictedFundings(
364✔
507
    signal?: AbortSignal,
364✔
508
  ): Promise<PredictedFundingsResponse> {
364✔
509
    return predictedFundings(this.config_, signal);
366✔
510
  }
366✔
511

512
  /** @see {@link preTransferCheck} */
513
  preTransferCheck(
364✔
514
    params: PreTransferCheckParameters,
364✔
515
    signal?: AbortSignal,
364✔
516
  ): Promise<PreTransferCheckResponse> {
364✔
517
    return preTransferCheck(this.config_, params, signal);
366✔
518
  }
366✔
519

520
  /** @see {@link recentTrades} */
521
  recentTrades(
364✔
522
    params: RecentTradesParameters,
364✔
523
    signal?: AbortSignal,
364✔
524
  ): Promise<RecentTradesResponse> {
364✔
525
    return recentTrades(this.config_, params, signal);
366✔
526
  }
366✔
527

528
  /** @see {@link referral} */
529
  referral(
364✔
530
    params: ReferralParameters,
364✔
531
    signal?: AbortSignal,
364✔
532
  ): Promise<ReferralResponse> {
364✔
533
    return referral(this.config_, params, signal);
370✔
534
  }
370✔
535

536
  /** @see {@link spotClearinghouseState} */
537
  spotClearinghouseState(
364✔
538
    params: SpotClearinghouseStateParameters,
364✔
539
    signal?: AbortSignal,
364✔
540
  ): Promise<SpotClearinghouseStateResponse> {
364✔
541
    return spotClearinghouseState(this.config_, params, signal);
459✔
542
  }
459✔
543

544
  /** @see {@link spotDeployState} */
545
  spotDeployState(
364✔
546
    params: SpotDeployStateParameters,
364✔
547
    signal?: AbortSignal,
364✔
548
  ): Promise<SpotDeployStateResponse> {
364✔
549
    return spotDeployState(this.config_, params, signal);
369✔
550
  }
369✔
551

552
  /** @see {@link spotMeta} */
553
  spotMeta(
364✔
554
    signal?: AbortSignal,
364✔
555
  ): Promise<SpotMetaResponse> {
364✔
556
    return spotMeta(this.config_, signal);
366✔
557
  }
366✔
558

559
  /** @see {@link spotMetaAndAssetCtxs} */
560
  spotMetaAndAssetCtxs(
364✔
561
    signal?: AbortSignal,
364✔
562
  ): Promise<SpotMetaAndAssetCtxsResponse> {
364✔
563
    return spotMetaAndAssetCtxs(this.config_, signal);
366✔
564
  }
366✔
565

566
  /** @see {@link spotPairDeployAuctionStatus} */
567
  spotPairDeployAuctionStatus(
364✔
568
    signal?: AbortSignal,
364✔
569
  ): Promise<SpotPairDeployAuctionStatusResponse> {
364✔
570
    return spotPairDeployAuctionStatus(this.config_, signal);
366✔
571
  }
366✔
572

573
  /** @see {@link subAccounts} */
574
  subAccounts(
364✔
575
    params: SubAccountsParameters,
364✔
576
    signal?: AbortSignal,
364✔
577
  ): Promise<SubAccountsResponse> {
364✔
578
    return subAccounts(this.config_, params, signal);
367✔
579
  }
367✔
580

581
  /** @see {@link subAccounts2} */
582
  subAccounts2(
364✔
583
    params: SubAccounts2Parameters,
364✔
584
    signal?: AbortSignal,
364✔
585
  ): Promise<SubAccounts2Response> {
364✔
586
    return subAccounts2(this.config_, params, signal);
367✔
587
  }
367✔
588

589
  /** @see {@link tokenDetails} */
590
  tokenDetails(
364✔
591
    params: TokenDetailsParameters,
364✔
592
    signal?: AbortSignal,
364✔
593
  ): Promise<TokenDetailsResponse> {
364✔
594
    return tokenDetails(this.config_, params, signal);
373✔
595
  }
373✔
596

597
  /** @see {@link twapHistory} */
598
  twapHistory(
364✔
599
    params: TwapHistoryParameters,
364✔
600
    signal?: AbortSignal,
364✔
601
  ): Promise<TwapHistoryResponse> {
364✔
602
    return twapHistory(this.config_, params, signal);
366✔
603
  }
366✔
604

605
  /** @see {@link txDetails} */
606
  txDetails(
364✔
607
    params: TxDetailsParameters,
364✔
608
    signal?: AbortSignal,
364✔
609
  ): Promise<TxDetailsResponse> {
364✔
610
    return txDetails(this.config_, params, signal);
367✔
611
  }
367✔
612

613
  /** @see {@link userDetails} */
614
  userDetails(
364✔
615
    params: UserDetailsParameters,
364✔
616
    signal?: AbortSignal,
364✔
617
  ): Promise<UserDetailsResponse> {
364✔
618
    return userDetails(this.config_, params, signal);
366✔
619
  }
366✔
620

621
  /** @see {@link userDexAbstraction} */
622
  userDexAbstraction(
364✔
623
    params: UserDexAbstractionParameters,
364✔
624
    signal?: AbortSignal,
364✔
625
  ): Promise<UserDexAbstractionResponse> {
364✔
626
    return userDexAbstraction(this.config_, params, signal);
367✔
627
  }
367✔
628

629
  /** @see {@link userFees} */
630
  userFees(
364✔
631
    params: UserFeesParameters,
364✔
632
    signal?: AbortSignal,
364✔
633
  ): Promise<UserFeesResponse> {
364✔
634
    return userFees(this.config_, params, signal);
366✔
635
  }
366✔
636

637
  /** @see {@link userFills} */
638
  userFills(
364✔
639
    params: UserFillsParameters,
364✔
640
    signal?: AbortSignal,
364✔
641
  ): Promise<UserFillsResponse> {
364✔
642
    return userFills(this.config_, params, signal);
366✔
643
  }
366✔
644

645
  /** @see {@link userFillsByTime} */
646
  userFillsByTime(
364✔
647
    params: UserFillsByTimeParameters,
364✔
648
    signal?: AbortSignal,
364✔
649
  ): Promise<UserFillsByTimeResponse> {
364✔
650
    return userFillsByTime(this.config_, params, signal);
366✔
651
  }
366✔
652

653
  /** @see {@link userFunding} */
654
  userFunding(
364✔
655
    params: UserFundingParameters,
364✔
656
    signal?: AbortSignal,
364✔
657
  ): Promise<UserFundingResponse> {
364✔
658
    return userFunding(this.config_, params, signal);
366✔
659
  }
366✔
660

661
  /** @see {@link userNonFundingLedgerUpdates} */
662
  userNonFundingLedgerUpdates(
364✔
663
    params: UserNonFundingLedgerUpdatesParameters,
364✔
664
    signal?: AbortSignal,
364✔
665
  ): Promise<UserNonFundingLedgerUpdatesResponse> {
364✔
666
    return userNonFundingLedgerUpdates(this.config_, params, signal);
367✔
667
  }
367✔
668

669
  /** @see {@link userRateLimit} */
670
  userRateLimit(
364✔
671
    params: UserRateLimitParameters,
364✔
672
    signal?: AbortSignal,
364✔
673
  ): Promise<UserRateLimitResponse> {
364✔
674
    return userRateLimit(this.config_, params, signal);
366✔
675
  }
366✔
676

677
  /** @see {@link userRole} */
678
  userRole(
364✔
679
    params: UserRoleParameters,
364✔
680
    signal?: AbortSignal,
364✔
681
  ): Promise<UserRoleResponse> {
364✔
682
    return userRole(this.config_, params, signal);
370✔
683
  }
370✔
684

685
  /** @see {@link userToMultiSigSigners} */
686
  userToMultiSigSigners(
364✔
687
    params: UserToMultiSigSignersParameters,
364✔
688
    signal?: AbortSignal,
364✔
689
  ): Promise<UserToMultiSigSignersResponse> {
364✔
690
    return userToMultiSigSigners(this.config_, params, signal);
367✔
691
  }
367✔
692

693
  /** @see {@link userTwapSliceFills} */
694
  userTwapSliceFills(
364✔
695
    params: UserTwapSliceFillsParameters,
364✔
696
    signal?: AbortSignal,
364✔
697
  ): Promise<UserTwapSliceFillsResponse> {
364✔
698
    return userTwapSliceFills(this.config_, params, signal);
366✔
699
  }
366✔
700

701
  /** @see {@link userTwapSliceFillsByTime} */
702
  userTwapSliceFillsByTime(
364✔
703
    params: UserTwapSliceFillsByTimeParameters,
364✔
704
    signal?: AbortSignal,
364✔
705
  ): Promise<UserTwapSliceFillsByTimeResponse> {
364✔
706
    return userTwapSliceFillsByTime(this.config_, params, signal);
366✔
707
  }
366✔
708

709
  /** @see {@link userVaultEquities} */
710
  userVaultEquities(
364✔
711
    params: UserVaultEquitiesParameters,
364✔
712
    signal?: AbortSignal,
364✔
713
  ): Promise<UserVaultEquitiesResponse> {
364✔
714
    return userVaultEquities(this.config_, params, signal);
366✔
715
  }
366✔
716

717
  /** @see {@link validatorL1Votes} */
718
  validatorL1Votes(
364✔
719
    signal?: AbortSignal,
364✔
720
  ): Promise<ValidatorL1VotesResponse> {
364✔
721
    return validatorL1Votes(this.config_, signal);
366✔
722
  }
366✔
723

724
  /** @see {@link validatorSummaries} */
725
  validatorSummaries(
364✔
726
    signal?: AbortSignal,
364✔
727
  ): Promise<ValidatorSummariesResponse> {
364✔
728
    return validatorSummaries(this.config_, signal);
366✔
729
  }
366✔
730

731
  /** @see {@link vaultDetails} */
732
  vaultDetails(
364✔
733
    params: VaultDetailsParameters,
364✔
734
    signal?: AbortSignal,
364✔
735
  ): Promise<VaultDetailsResponse> {
364✔
736
    return vaultDetails(this.config_, params, signal);
368✔
737
  }
368✔
738

739
  /** @see {@link vaultSummaries} */
740
  vaultSummaries(
364✔
741
    signal?: AbortSignal,
364✔
742
  ): Promise<VaultSummariesResponse> {
364✔
743
    return vaultSummaries(this.config_, signal);
366✔
744
  }
366✔
745

746
  /** @see {@link webData2} */
747
  webData2(
364✔
748
    params: WebData2Parameters,
364✔
749
    signal?: AbortSignal,
364✔
750
  ): Promise<WebData2Response> {
364✔
751
    return webData2(this.config_, params, signal);
461✔
752
  }
461✔
753
}
364✔
754

755
// =============================================================
756
// Type Re-exports
757
// =============================================================
758

759
export type { InfoConfig } from "./_methods/_base/types.ts";
760

761
export type { ActiveAssetDataParameters, ActiveAssetDataResponse } from "./_methods/activeAssetData.ts";
762
export type {
763
  AlignedQuoteTokenInfoParameters,
764
  AlignedQuoteTokenInfoResponse,
765
} from "./_methods/alignedQuoteTokenInfo.ts";
766
export type { AllMidsParameters, AllMidsResponse } from "./_methods/allMids.ts";
767
export type { AllPerpMetasResponse } from "./_methods/allPerpMetas.ts";
768
export type { BlockDetailsParameters, BlockDetailsResponse } from "./_methods/blockDetails.ts";
769
export type { CandleSnapshotParameters, CandleSnapshotResponse } from "./_methods/candleSnapshot.ts";
770
export type { ClearinghouseStateParameters, ClearinghouseStateResponse } from "./_methods/clearinghouseState.ts";
771
export type { DelegationsParameters, DelegationsResponse } from "./_methods/delegations.ts";
772
export type { DelegatorHistoryParameters, DelegatorHistoryResponse } from "./_methods/delegatorHistory.ts";
773
export type { DelegatorRewardsParameters, DelegatorRewardsResponse } from "./_methods/delegatorRewards.ts";
774
export type { DelegatorSummaryParameters, DelegatorSummaryResponse } from "./_methods/delegatorSummary.ts";
775
export type { ExchangeStatusResponse } from "./_methods/exchangeStatus.ts";
776
export type { ExtraAgentsParameters, ExtraAgentsResponse } from "./_methods/extraAgents.ts";
777
export type { FrontendOpenOrdersParameters, FrontendOpenOrdersResponse } from "./_methods/frontendOpenOrders.ts";
778
export type { FundingHistoryParameters, FundingHistoryResponse } from "./_methods/fundingHistory.ts";
779
export type { GossipRootIpsResponse } from "./_methods/gossipRootIps.ts";
780
export type { HistoricalOrdersParameters, HistoricalOrdersResponse } from "./_methods/historicalOrders.ts";
781
export type { IsVipParameters, IsVipResponse } from "./_methods/isVip.ts";
782
export type { L2BookParameters, L2BookResponse } from "./_methods/l2Book.ts";
783
export type { LeadingVaultsParameters, LeadingVaultsResponse } from "./_methods/leadingVaults.ts";
784
export type { LegalCheckParameters, LegalCheckResponse } from "./_methods/legalCheck.ts";
785
export type { LiquidatableResponse } from "./_methods/liquidatable.ts";
786
export type { MarginTableParameters, MarginTableResponse } from "./_methods/marginTable.ts";
787
export type { MaxBuilderFeeParameters, MaxBuilderFeeResponse } from "./_methods/maxBuilderFee.ts";
788
export type { MaxMarketOrderNtlsResponse } from "./_methods/maxMarketOrderNtls.ts";
789
export type { MetaParameters, MetaResponse } from "./_methods/meta.ts";
790
export type { MetaAndAssetCtxsParameters, MetaAndAssetCtxsResponse } from "./_methods/metaAndAssetCtxs.ts";
791
export type { OpenOrdersParameters, OpenOrdersResponse } from "./_methods/openOrders.ts";
792
export type { OrderStatusParameters, OrderStatusResponse } from "./_methods/orderStatus.ts";
793
export type { PerpDeployAuctionStatusResponse } from "./_methods/perpDeployAuctionStatus.ts";
794
export type { PerpDexLimitsParameters, PerpDexLimitsResponse } from "./_methods/perpDexLimits.ts";
795
export type { PerpDexsResponse } from "./_methods/perpDexs.ts";
796
export type { PerpDexStatusParameters, PerpDexStatusResponse } from "./_methods/perpDexStatus.ts";
797
export type {
798
  PerpsAtOpenInterestCapParameters,
799
  PerpsAtOpenInterestCapResponse,
800
} from "./_methods/perpsAtOpenInterestCap.ts";
801
export type { PortfolioParameters, PortfolioResponse } from "./_methods/portfolio.ts";
802
export type { PredictedFundingsResponse } from "./_methods/predictedFundings.ts";
803
export type { PreTransferCheckParameters, PreTransferCheckResponse } from "./_methods/preTransferCheck.ts";
804
export type { RecentTradesParameters, RecentTradesResponse } from "./_methods/recentTrades.ts";
805
export type { ReferralParameters, ReferralResponse } from "./_methods/referral.ts";
806
export type {
807
  SpotClearinghouseStateParameters,
808
  SpotClearinghouseStateResponse,
809
} from "./_methods/spotClearinghouseState.ts";
810
export type { SpotDeployStateParameters, SpotDeployStateResponse } from "./_methods/spotDeployState.ts";
811
export type { SpotMetaResponse } from "./_methods/spotMeta.ts";
812
export type { SpotMetaAndAssetCtxsResponse } from "./_methods/spotMetaAndAssetCtxs.ts";
813
export type { SpotPairDeployAuctionStatusResponse } from "./_methods/spotPairDeployAuctionStatus.ts";
814
export type { SubAccountsParameters, SubAccountsResponse } from "./_methods/subAccounts.ts";
815
export type { SubAccounts2Parameters, SubAccounts2Response } from "./_methods/subAccounts2.ts";
816
export type { TokenDetailsParameters, TokenDetailsResponse } from "./_methods/tokenDetails.ts";
817
export type { TwapHistoryParameters, TwapHistoryResponse } from "./_methods/twapHistory.ts";
818
export type { TxDetailsParameters, TxDetailsResponse } from "./_methods/txDetails.ts";
819
export type { UserDetailsParameters, UserDetailsResponse } from "./_methods/userDetails.ts";
820
export type {
821
  UserDexAbstractionParameters as UserDexAbstractionInfoParameters,
822
  UserDexAbstractionResponse as UserDexAbstractionInfoResponse,
823
} from "./_methods/userDexAbstraction.ts";
824
export type { UserFeesParameters, UserFeesResponse } from "./_methods/userFees.ts";
825
export type { UserFillsParameters, UserFillsResponse } from "./_methods/userFills.ts";
826
export type { UserFillsByTimeParameters, UserFillsByTimeResponse } from "./_methods/userFillsByTime.ts";
827
export type { UserFundingParameters, UserFundingResponse } from "./_methods/userFunding.ts";
828
export type {
829
  UserNonFundingLedgerUpdatesParameters,
830
  UserNonFundingLedgerUpdatesResponse,
831
} from "./_methods/userNonFundingLedgerUpdates.ts";
832
export type { UserRateLimitParameters, UserRateLimitResponse } from "./_methods/userRateLimit.ts";
833
export type { UserRoleParameters, UserRoleResponse } from "./_methods/userRole.ts";
834
export type {
835
  UserToMultiSigSignersParameters,
836
  UserToMultiSigSignersResponse,
837
} from "./_methods/userToMultiSigSigners.ts";
838
export type { UserTwapSliceFillsParameters, UserTwapSliceFillsResponse } from "./_methods/userTwapSliceFills.ts";
839
export type {
840
  UserTwapSliceFillsByTimeParameters,
841
  UserTwapSliceFillsByTimeResponse,
842
} from "./_methods/userTwapSliceFillsByTime.ts";
843
export type { UserVaultEquitiesParameters, UserVaultEquitiesResponse } from "./_methods/userVaultEquities.ts";
844
export type { ValidatorL1VotesResponse } from "./_methods/validatorL1Votes.ts";
845
export type { ValidatorSummariesResponse } from "./_methods/validatorSummaries.ts";
846
export type { VaultDetailsParameters, VaultDetailsResponse } from "./_methods/vaultDetails.ts";
847
export type { VaultSummariesResponse } from "./_methods/vaultSummaries.ts";
848
export type { WebData2Parameters, WebData2Response } from "./_methods/webData2.ts";
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc