@nktkas/hyperliquid
Version:
Unofficial Hyperliquid API SDK for all major JS runtimes, written in TypeScript and provided with tests
1,035 lines • 45.4 kB
TypeScript
import type { IRequestTransport } from "../transports/base.js";
import type { BlockDetailsRequest, TxDetailsRequest, UserDetailsRequest } from "../types/explorer/requests.js";
import type { BlockDetails, TxDetails } from "../types/explorer/responses.js";
import type { ExtraAgent, LegalCheck, MultiSigSigners, PerpsClearinghouseState, PortfolioPeriods, PreTransferCheck, Referral, SpotClearinghouseState, SubAccount, UserFees, UserFundingUpdate, UserNonFundingLedgerUpdate, UserRateLimit, UserRole } from "../types/info/accounts.js";
import type { AllMids, Candle, FundingHistory, PerpDex, PerpsMeta, PerpsMetaAndAssetCtxs, PredictedFunding, SpotMeta, SpotMetaAndAssetCtxs, TokenDetails } from "../types/info/assets.js";
import type { Delegation, DelegatorReward, DelegatorSummary, DelegatorUpdate, ValidatorSummary } from "../types/info/delegations.js";
import type { DeployAuctionStatus, SpotDeployState } from "../types/info/markets.js";
import type { Book, Fill, FrontendOrder, Order, OrderLookup, OrderStatus, TwapHistory, TwapSliceFill } from "../types/info/orders.js";
import type { AllMidsRequest, CandleSnapshotRequest, ClearinghouseStateRequest, DelegationsRequest, DelegatorHistoryRequest, DelegatorRewardsRequest, DelegatorSummaryRequest, ExtraAgentsRequest, FrontendOpenOrdersRequest, FundingHistoryRequest, HistoricalOrdersRequest, IsVipRequest, L2BookRequest, LegalCheckRequest, MaxBuilderFeeRequest, MetaRequest, OpenOrdersRequest, OrderStatusRequest, PerpDeployAuctionStatusRequest, PerpDexsRequest, PortfolioRequest, PreTransferCheckRequest, ReferralRequest, SpotClearinghouseStateRequest, SpotDeployStateRequest, SubAccountsRequest, TokenDetailsRequest, TwapHistoryRequest, UserFeesRequest, UserFillsByTimeRequest, UserFillsRequest, UserFundingRequest, UserNonFundingLedgerUpdatesRequest, UserRateLimitRequest, UserRoleRequest, UserToMultiSigSignersRequest, UserTwapSliceFillsByTimeRequest, UserTwapSliceFillsRequest, UserVaultEquitiesRequest, VaultDetailsRequest } from "../types/info/requests.js";
import type { VaultDetails, VaultEquity, VaultSummary } from "../types/info/vaults.js";
/** Parameters for the {@linkcode InfoClient} constructor. */
export interface InfoClientParameters<T extends IRequestTransport = IRequestTransport> {
/** The transport used to connect to the Hyperliquid API. */
transport: T;
}
/** Parameters for the {@linkcode InfoClient.allMids} method. */
export type AllMidsParameters = Omit<AllMidsRequest, "type">;
/** Parameters for the {@linkcode InfoClient.candleSnapshot} method. */
export type CandleSnapshotParameters = CandleSnapshotRequest["req"];
/** Parameters for the {@linkcode InfoClient.clearinghouseState} method. */
export type ClearinghouseStateParameters = Omit<ClearinghouseStateRequest, "type">;
/** Parameters for the {@linkcode InfoClient.delegations} method. */
export type DelegationsParameters = Omit<DelegationsRequest, "type">;
/** Parameters for the {@linkcode InfoClient.delegatorHistory} method. */
export type DelegatorHistoryParameters = Omit<DelegatorHistoryRequest, "type">;
/** Parameters for the {@linkcode InfoClient.delegatorRewards} method. */
export type DelegatorRewardsParameters = Omit<DelegatorRewardsRequest, "type">;
/** Parameters for the {@linkcode InfoClient.delegatorSummary} method. */
export type DelegatorSummaryParameters = Omit<DelegatorSummaryRequest, "type">;
/** Parameters for the {@linkcode InfoClient.extraAgents} method. */
export type ExtraAgentsParameters = Omit<ExtraAgentsRequest, "type">;
/** Parameters for the {@linkcode InfoClient.frontendOpenOrders} method. */
export type FrontendOpenOrdersParameters = Omit<FrontendOpenOrdersRequest, "type">;
/** Parameters for the {@linkcode InfoClient.fundingHistory} method. */
export type FundingHistoryParameters = Omit<FundingHistoryRequest, "type">;
/** Parameters for the {@linkcode InfoClient.historicalOrders} method. */
export type HistoricalOrdersParameters = Omit<HistoricalOrdersRequest, "type">;
/** Parameters for the {@linkcode InfoClient.isVip} method. */
export type IsVipParameters = Omit<IsVipRequest, "type">;
/** Parameters for the {@linkcode InfoClient.l2Book} method. */
export type L2BookParameters = Omit<L2BookRequest, "type">;
/** Parameters for the {@linkcode InfoClient.legalCheck} method. */
export type LegalCheckParameters = Omit<LegalCheckRequest, "type">;
/** Parameters for the {@linkcode InfoClient.maxBuilderFee} method. */
export type MaxBuilderFeeParameters = Omit<MaxBuilderFeeRequest, "type">;
/** Parameters for the {@linkcode InfoClient.meta} method. */
export type MetaParameters = Omit<MetaRequest, "type">;
/** Parameters for the {@linkcode InfoClient.openOrders} method. */
export type OpenOrdersParameters = Omit<OpenOrdersRequest, "type">;
/** Parameters for the {@linkcode InfoClient.orderStatus} method. */
export type OrderStatusParameters = Omit<OrderStatusRequest, "type">;
/** Parameters for the {@linkcode InfoClient.perpDeployAuctionStatus} method. */
export type PerpDeployAuctionStatusParameters = Omit<PerpDeployAuctionStatusRequest, "type">;
/** Parameters for the {@linkcode InfoClient.perpDexs} method. */
export type PerpDexsParameters = Omit<PerpDexsRequest, "type">;
/** Parameters for the {@linkcode InfoClient.portfolio} method. */
export type PortfolioParameters = Omit<PortfolioRequest, "type">;
/** Parameters for the {@linkcode InfoClient.preTransferCheck} method. */
export type PreTransferCheckParameters = Omit<PreTransferCheckRequest, "type">;
/** Parameters for the {@linkcode InfoClient.referral} method. */
export type ReferralParameters = Omit<ReferralRequest, "type">;
/** Parameters for the {@linkcode InfoClient.spotClearinghouseState} method. */
export type SpotClearinghouseStateParameters = Omit<SpotClearinghouseStateRequest, "type">;
/** Parameters for the {@linkcode InfoClient.spotDeployState} method. */
export type SpotDeployStateParameters = Omit<SpotDeployStateRequest, "type">;
/** Parameters for the {@linkcode InfoClient.subAccounts} method. */
export type SubAccountsParameters = Omit<SubAccountsRequest, "type">;
/** Parameters for the {@linkcode InfoClient.tokenDetails} method. */
export type TokenDetailsParameters = Omit<TokenDetailsRequest, "type">;
/** Parameters for the {@linkcode InfoClient.twapHistory} method. */
export type TwapHistoryParameters = Omit<TwapHistoryRequest, "type">;
/** Parameters for the {@linkcode InfoClient.userFees} method. */
export type UserFeesParameters = Omit<UserFeesRequest, "type">;
/** Parameters for the {@linkcode InfoClient.userFills} method. */
export type UserFillsParameters = Omit<UserFillsRequest, "type">;
/** Parameters for the {@linkcode InfoClient.userFillsByTime} method. */
export type UserFillsByTimeParameters = Omit<UserFillsByTimeRequest, "type">;
/** Parameters for the {@linkcode InfoClient.userFunding} method. */
export type UserFundingParameters = Omit<UserFundingRequest, "type">;
/** Parameters for the {@linkcode InfoClient.userNonFundingLedgerUpdates} method. */
export type UserNonFundingLedgerUpdatesParameters = Omit<UserNonFundingLedgerUpdatesRequest, "type">;
/** Parameters for the {@linkcode InfoClient.userRateLimit} method. */
export type UserRateLimitParameters = Omit<UserRateLimitRequest, "type">;
/** Parameters for the {@linkcode InfoClient.userRole} method. */
export type UserRoleParameters = Omit<UserRoleRequest, "type">;
/** Parameters for the {@linkcode InfoClient.userToMultiSigSigners} method. */
export type UserToMultiSigSignersParameters = Omit<UserToMultiSigSignersRequest, "type">;
/** Parameters for the {@linkcode InfoClient.userTwapSliceFills} method. */
export type UserTwapSliceFillsParameters = Omit<UserTwapSliceFillsRequest, "type">;
/** Parameters for the {@linkcode InfoClient.userTwapSliceFillsByTime} method. */
export type UserTwapSliceFillsByTimeParameters = Omit<UserTwapSliceFillsByTimeRequest, "type">;
/** Parameters for the {@linkcode InfoClient.userVaultEquities} method. */
export type UserVaultEquitiesParameters = Omit<UserVaultEquitiesRequest, "type">;
/** Parameters for the {@linkcode InfoClient.vaultDetails} method. */
export type VaultDetailsParameters = Omit<VaultDetailsRequest, "type">;
/** Parameters for the {@linkcode InfoClient.blockDetails} method. */
export type BlockDetailsParameters = Omit<BlockDetailsRequest, "type">;
/** Parameters for the {@linkcode InfoClient.txDetails} method. */
export type TxDetailsParameters = Omit<TxDetailsRequest, "type">;
/** Parameters for the {@linkcode InfoClient.userDetails} method. */
export type UserDetailsParameters = Omit<UserDetailsRequest, "type">;
/**
* Info client for interacting with the Hyperliquid API.
* @typeParam T The type of transport used to connect to the Hyperliquid API.
*/
export declare class InfoClient<T extends IRequestTransport = IRequestTransport> implements InfoClientParameters<T>, AsyncDisposable {
transport: T;
/**
* Initialises a new instance.
* @param args - The arguments for initialisation.
*
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
* ```
*/
constructor(args: InfoClientParameters<T>);
/**
* Request mid coin prices.
* @param signal - An optional abort signal.
* @returns Mid coin prices.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.allMids();
* ```
*/
allMids(args?: AllMidsParameters, signal?: AbortSignal): Promise<AllMids>;
allMids(signal?: AbortSignal): Promise<AllMids>;
/**
* Block details by block height.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Block details response.
*
* @see null - no documentation
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.blockDetails({ height: 123 });
* ```
*/
blockDetails(args: BlockDetailsParameters, signal?: AbortSignal): Promise<BlockDetails>;
/**
* Request candlestick snapshots.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of candlestick data points.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candle-snapshot
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.candleSnapshot({
* coin: "ETH",
* interval: "1h",
* startTime: Date.now() - 1000 * 60 * 60 * 24
* });
* ```
*/
candleSnapshot(args: CandleSnapshotParameters, signal?: AbortSignal): Promise<Candle[]>;
/**
* Request clearinghouse state.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Account summary for perpetual trading.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-perpetuals-account-summary
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.clearinghouseState({ user: "0x..." });
* ```
*/
clearinghouseState(args: ClearinghouseStateParameters, signal?: AbortSignal): Promise<PerpsClearinghouseState>;
/**
* Request user staking delegations.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of user's delegations to validators.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-delegations
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.delegations({ user: "0x..." });
* ```
*/
delegations(args: DelegationsParameters, signal?: AbortSignal): Promise<Delegation[]>;
/**
* Request user staking history.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of user's staking updates.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-history
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.delegatorHistory({ user: "0x..." });
* ```
*/
delegatorHistory(args: DelegatorHistoryParameters, signal?: AbortSignal): Promise<DelegatorUpdate[]>;
/**
* Request user staking rewards.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of user's staking rewards.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-rewards
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.delegatorRewards({ user: "0x..." });
* ```
*/
delegatorRewards(args: DelegatorRewardsParameters, signal?: AbortSignal): Promise<DelegatorReward[]>;
/**
* Request user staking summary.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Summary of a user's staking delegations.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.delegatorSummary({ user: "0x..." });
* ```
*/
delegatorSummary(args: DelegatorSummaryParameters, signal?: AbortSignal): Promise<DelegatorSummary>;
/**
* Request user's extra agents.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns User's extra agents.
*
* @see null - no documentation
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.extraAgents({ user: "0x..." });
* ```
*/
extraAgents(args: ExtraAgentsParameters, signal?: AbortSignal): Promise<ExtraAgent[]>;
/**
* Request frontend open orders.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of open orders with additional frontend information.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.frontendOpenOrders({ user: "0x..." });
* ```
*/
frontendOpenOrders(args: FrontendOpenOrdersParameters, signal?: AbortSignal): Promise<FrontendOrder[]>;
/**
* Request funding history.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of historical funding rate data for an asset.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.fundingHistory({
* coin: "ETH",
* startTime: Date.now() - 1000 * 60 * 60 * 24
* });
* ```
*/
fundingHistory(args: FundingHistoryParameters, signal?: AbortSignal): Promise<FundingHistory[]>;
/**
* Request user's historical orders.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of user's historical orders.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.historicalOrders({ user: "0x..." });
* ```
*/
historicalOrders(args: HistoricalOrdersParameters, signal?: AbortSignal): Promise<OrderStatus<FrontendOrder>[]>;
/**
* Request to check if a user is a VIP.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Boolean indicating user's VIP status.
*
* @see null - no documentation
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.isVip({ user: "0x..." });
* ```
*/
isVip(args: IsVipParameters, signal?: AbortSignal): Promise<boolean>;
/**
* Request L2 order book.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns L2 order book snapshot.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.l2Book({ coin: "ETH", nSigFigs: 2 });
* ```
*/
l2Book(args: L2BookParameters, signal?: AbortSignal): Promise<Book>;
/**
* Request legal verification status of a user.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Legal verification status for a user.
*
* @see null - no documentation
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.legalCheck({ user: "0x..." });
* ```
*/
legalCheck(args: LegalCheckParameters, signal?: AbortSignal): Promise<LegalCheck>;
/**
* Request builder fee approval.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Maximum builder fee approval.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#check-builder-fee-approval
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.maxBuilderFee({ user: "0x...", builder: "0x..." });
* ```
*/
maxBuilderFee(args: MaxBuilderFeeParameters, signal?: AbortSignal): Promise<number>;
/**
* Request trading metadata.
* @param signal - An optional abort signal.
* @returns Metadata for perpetual assets.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-metadata
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.meta();
* ```
*/
meta(args?: MetaParameters, signal?: AbortSignal): Promise<PerpsMeta>;
meta(signal?: AbortSignal): Promise<PerpsMeta>;
/**
* Request metadata and asset contexts.
* @param signal - An optional abort signal.
* @returns Metadata and context information for each perpetual asset.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-asset-contexts-includes-mark-price-current-funding-open-interest-etc
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.metaAndAssetCtxs();
* ```
*/
metaAndAssetCtxs(signal?: AbortSignal): Promise<PerpsMetaAndAssetCtxs>;
/**
* Request open orders.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of open order.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.openOrders({ user: "0x..." });
* ```
*/
openOrders(args: OpenOrdersParameters, signal?: AbortSignal): Promise<Order[]>;
/**
* Request order status.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Result of an order status lookup.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.orderStatus({ user: "0x...", oid: 12345 });
* ```
*/
orderStatus(args: OrderStatusParameters, signal?: AbortSignal): Promise<OrderLookup>;
/**
* Request for the status of the perpetual deploy auction.
* @param signal - An optional abort signal.
* @returns Status of the perpetual deploy auction.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.perpDeployAuctionStatus();
* ```
*/
perpDeployAuctionStatus(signal?: AbortSignal): Promise<DeployAuctionStatus>;
/**
* Request all perpetual dexs.
* @param signal - An optional abort signal.
* @returns Array of perpetual dexes.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.perpDexs();
* ```
*/
perpDexs(signal?: AbortSignal): Promise<(PerpDex | null)[]>;
/**
* Request perpetuals at open interest cap.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of perpetuals at open interest caps.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.perpsAtOpenInterestCap();
* ```
*/
perpsAtOpenInterestCap(signal?: AbortSignal): Promise<string[]>;
/**
* Request portfolio.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Portfolio of a user.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.portfolio({ user: "0x..." });
* ```
*/
portfolio(args: PortfolioParameters, signal?: AbortSignal): Promise<PortfolioPeriods>;
/**
* Request predicted funding rates.
* @param signal - An optional abort signal.
* @returns Array of predicted funding rates.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.predictedFundings();
* ```
*/
predictedFundings(signal?: AbortSignal): Promise<PredictedFunding[]>;
/**
* Request user's existence check before transfer.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Pre-transfer user existence check result.
*
* @see null - no documentation
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.preTransferCheck({ user: "0x...", source: "0x..." });
* ```
*/
preTransferCheck(args: PreTransferCheckParameters, signal?: AbortSignal): Promise<PreTransferCheck>;
/**
* Request user referral.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Referral information for a user.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.referral({ user: "0x..." });
* ```
*/
referral(args: ReferralParameters, signal?: AbortSignal): Promise<Referral>;
/**
* Request spot clearinghouse state.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Balances for spot tokens.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.spotClearinghouseState({ user: "0x..." });
* ```
*/
spotClearinghouseState(args: SpotClearinghouseStateParameters, signal?: AbortSignal): Promise<SpotClearinghouseState>;
/**
* Request spot deploy state.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns The deploy state of a user.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.spotDeployState({ user: "0x..." });
* ```
*/
spotDeployState(args: SpotDeployStateParameters, signal?: AbortSignal): Promise<SpotDeployState>;
/**
* Request spot trading metadata.
* @param signal - An optional abort signal.
* @returns Metadata for spot assets.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.spotMeta();
* ```
*/
spotMeta(signal?: AbortSignal): Promise<SpotMeta>;
/**
* Request spot metadata and asset contexts.
* @param signal - An optional abort signal.
* @returns Metadata and context information for each spot asset.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.spotMetaAndAssetCtxs();
* ```
*/
spotMetaAndAssetCtxs(signal?: AbortSignal): Promise<SpotMetaAndAssetCtxs>;
/**
* Request user sub-accounts.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of user sub-account or null if the user does not have any sub-accounts.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.subAccounts({ user: "0x..." });
* ```
*/
subAccounts(args: SubAccountsParameters, signal?: AbortSignal): Promise<SubAccount[] | null>;
/**
* Request token details.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns The details of a token.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.tokenDetails({ tokenId: "0x..." });
* ```
*/
tokenDetails(args: TokenDetailsParameters, signal?: AbortSignal): Promise<TokenDetails>;
/**
* Request twap history of a user.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns The twap history of a user.
*
* @see null - no documentation
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.twapHistory({ user: "0x..." });
* ```
*/
twapHistory(args: TwapHistoryParameters, signal?: AbortSignal): Promise<TwapHistory[]>;
/**
* Transaction details by transaction hash.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Transaction details response.
*
* @see null - no documentation
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.txDetails({ hash: "0x..." });
* ```
*/
txDetails(args: TxDetailsParameters, signal?: AbortSignal): Promise<TxDetails>;
/**
* User details by user's address.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns User details response.
*
* @see null - no documentation
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.userDetails({ user: "0x..." });
* ```
*/
userDetails(args: UserDetailsParameters, signal?: AbortSignal): Promise<TxDetails[]>;
/**
* Request user fees.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns User fees.
*
* @see null - no documentation
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.userFees({ user: "0x..." });
* ```
*/
userFees(args: UserFeesParameters, signal?: AbortSignal): Promise<UserFees>;
/**
* Request user fills.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of user's trade fill.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.userFills({ user: "0x..." });
* ```
*/
userFills(args: UserFillsParameters, signal?: AbortSignal): Promise<Fill[]>;
/**
* Request user fills by time.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of user's trade fill.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.userFillsByTime({
* user: "0x...",
* startTime: Date.now() - 1000 * 60 * 60 * 24
* });
* ```
*/
userFillsByTime(args: UserFillsByTimeParameters, signal?: AbortSignal): Promise<Fill[]>;
/**
* Request user funding.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of user's funding ledger update.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.userFunding({
* user: "0x...",
* startTime: Date.now() - 1000 * 60 * 60 * 24
* });
* ```
*/
userFunding(args: UserFundingParameters, signal?: AbortSignal): Promise<UserFundingUpdate[]>;
/**
* Request user non-funding ledger updates.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of user's non-funding ledger update.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.userNonFundingLedgerUpdates({
* user: "0x...",
* startTime: Date.now() - 1000 * 60 * 60 * 24
* });
* ```
*/
userNonFundingLedgerUpdates(args: UserNonFundingLedgerUpdatesParameters, signal?: AbortSignal): Promise<UserNonFundingLedgerUpdate[]>;
/**
* Request user rate limits.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns User's rate limits.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.userRateLimit({ user: "0x..." });
* ```
*/
userRateLimit(args: UserRateLimitParameters, signal?: AbortSignal): Promise<UserRateLimit>;
/**
* Request user role.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns User's role.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.userRole({ user: "0x..." });
* ```
*/
userRole(args: UserRoleParameters, signal?: AbortSignal): Promise<UserRole>;
/**
* Request multi-sig signers for a user.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Multi-sig signers for a user or null if the user does not have any multi-sig signers.
*
* @see null - no documentation
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.userToMultiSigSigners({ user: "0x..." });
* ```
*/
userToMultiSigSigners(args: UserToMultiSigSignersParameters, signal?: AbortSignal): Promise<MultiSigSigners | null>;
/**
* Request user twap slice fills.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of user's twap slice fill.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.userTwapSliceFills({ user: "0x..." });
* ```
*/
userTwapSliceFills(args: UserTwapSliceFillsParameters, signal?: AbortSignal): Promise<TwapSliceFill[]>;
/**
* Request user twap slice fills by time.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of user's twap slice fill.
*
* @see null - no documentation
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.userTwapSliceFillsByTime({
* user: "0x...",
* startTime: Date.now() - 1000 * 60 * 60 * 24
* });
* ```
*/
userTwapSliceFillsByTime(args: UserTwapSliceFillsByTimeParameters, signal?: AbortSignal): Promise<TwapSliceFill[]>;
/**
* Request user vault deposits.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of user's vault deposits.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.userVaultDeposits({ user: "0x..." });
* ```
*/
userVaultEquities(args: UserVaultEquitiesParameters, signal?: AbortSignal): Promise<VaultEquity[]>;
/**
* Request validator summaries.
* @param args - The parameters for the request.
* @returns Array of validator summaries.
*
* @see null - no documentation
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.validatorSummaries();
* ```
*/
validatorSummaries(signal?: AbortSignal): Promise<ValidatorSummary[]>;
/**
* Request details of a vault.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Details of a vault or null if the vault does not exist.
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.vaultDetails({ vaultAddress: "0x..." });
* ```
*/
vaultDetails(args: VaultDetailsParameters, signal?: AbortSignal): Promise<VaultDetails | null>;
/**
* Request a list of vaults less than 2 hours old.
* @param args - The parameters for the request.
* @param signal - An optional abort signal.
* @returns Array of vault summaries.
*
* @see null - no documentation
* @example
* ```ts
* import * as hl from "@nktkas/hyperliquid";
*
* const transport = new hl.HttpTransport(); // or WebSocketTransport
* const infoClient = new hl.InfoClient({ transport });
*
* const data = await infoClient.vaultSummaries();
* ```
*/
vaultSummaries(signal?: AbortSignal): Promise<VaultSummary[]>;
[Symbol.asyncDispose](): Promise<void>;
}
//# sourceMappingURL=info.d.ts.map