@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.1

package/esm/src/api/info/subAccounts.d.ts

@@ -0,0 +1,457 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request user sub-accounts.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
+ */
+export declare const SubAccountsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"subAccounts", undefined>, v.DescriptionAction<"subAccounts", "Type of request.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "subAccounts";
+    user: `0x${string}`;
+}, "Request user sub-accounts.">]>;
+export type SubAccountsRequest = v.InferOutput<typeof SubAccountsRequest>;
+/**
+ * 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
+ */
+export declare const SubAccountsResponse: v.SchemaWithPipe<readonly [v.NullableSchema<v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Sub-account name. */
+    readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.DescriptionAction<string, "Sub-account name.">]>;
+    /** Sub-account address. */
+    readonly subAccountUser: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Sub-account address.">]>;
+    /** Master account address. */
+    readonly master: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Master account address.">]>;
+    /** Perpetual trading clearinghouse state summary. */
+    readonly clearinghouseState: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Margin summary details. */
+        readonly marginSummary: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Total account value. */
+            readonly accountValue: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total account value.">]>;
+            /** Total notional position value. */
+            readonly totalNtlPos: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total notional position value.">]>;
+            /** Total raw USD value. */
+            readonly totalRawUsd: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total raw USD value.">]>;
+            /** Total margin used. */
+            readonly totalMarginUsed: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total margin used.">]>;
+        }, undefined>, v.DescriptionAction<{
+            accountValue: string;
+            totalNtlPos: string;
+            totalRawUsd: string;
+            totalMarginUsed: string;
+        }, "Margin summary details.">]>;
+        /** Cross-margin summary details. */
+        readonly crossMarginSummary: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Total account value. */
+            readonly accountValue: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total account value.">]>;
+            /** Total notional position value. */
+            readonly totalNtlPos: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total notional position value.">]>;
+            /** Total raw USD value. */
+            readonly totalRawUsd: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total raw USD value.">]>;
+            /** Total margin used. */
+            readonly totalMarginUsed: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total margin used.">]>;
+        }, undefined>, v.DescriptionAction<{
+            accountValue: string;
+            totalNtlPos: string;
+            totalRawUsd: string;
+            totalMarginUsed: string;
+        }, "Cross-margin summary details.">]>;
+        /** Maintenance margin used for cross-margin positions. */
+        readonly crossMaintenanceMarginUsed: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Maintenance margin used for cross-margin positions.">]>;
+        /** Amount available for withdrawal. */
+        readonly withdrawable: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Amount available for withdrawal.">]>;
+        /** Array of asset positions. */
+        readonly assetPositions: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Position type. */
+            readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"oneWay", undefined>, v.DescriptionAction<"oneWay", "Position type.">]>;
+            /** Position details. */
+            readonly position: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                /** Asset symbol. */
+                readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+                /** Signed position size. */
+                readonly szi: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Signed position size.">]>;
+                /** Leverage details. */
+                readonly leverage: v.SchemaWithPipe<readonly [v.UnionSchema<[v.ObjectSchema<{
+                    /** Leverage type. */
+                    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"isolated", undefined>, v.DescriptionAction<"isolated", "Leverage type.">]>;
+                    /** Leverage value used. */
+                    readonly value: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Leverage value used.">]>;
+                    /** Amount of USD used (1 = 1$). */
+                    readonly rawUsd: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Amount of USD used (1 = 1$).">]>;
+                }, undefined>, v.ObjectSchema<{
+                    /** Leverage type. */
+                    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"cross", undefined>, v.DescriptionAction<"cross", "Leverage type.">]>;
+                    /** Leverage value used. */
+                    readonly value: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Leverage value used.">]>;
+                }, undefined>], undefined>, v.DescriptionAction<{
+                    type: "isolated";
+                    value: number;
+                    rawUsd: string;
+                } | {
+                    type: "cross";
+                    value: number;
+                }, "Leverage details.">]>;
+                /** Average entry price. */
+                readonly entryPx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Average entry price.">]>;
+                /** Position value. */
+                readonly positionValue: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Position value.">]>;
+                /** Unrealized profit and loss. */
+                readonly unrealizedPnl: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Unrealized profit and loss.">]>;
+                /** Return on equity. */
+                readonly returnOnEquity: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Return on equity.">]>;
+                /** Liquidation price. */
+                readonly liquidationPx: v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.NullSchema<undefined>], undefined>, v.DescriptionAction<string | null, "Liquidation price.">]>;
+                /** Margin used. */
+                readonly marginUsed: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Margin used.">]>;
+                /** Maximum allowed leverage. */
+                readonly maxLeverage: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Maximum allowed leverage.">]>;
+                /** Cumulative funding details. */
+                readonly cumFunding: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                    /** Total funding paid or received since account opening. */
+                    readonly allTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total funding paid or received since account opening.">]>;
+                    /** Funding accumulated since the position was opened. */
+                    readonly sinceOpen: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Funding accumulated since the position was opened.">]>;
+                    /** Funding accumulated since the last change in position size. */
+                    readonly sinceChange: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Funding accumulated since the last change in position size.">]>;
+                }, undefined>, v.DescriptionAction<{
+                    allTime: string;
+                    sinceOpen: string;
+                    sinceChange: string;
+                }, "Cumulative funding details.">]>;
+            }, undefined>, v.DescriptionAction<{
+                coin: string;
+                szi: string;
+                leverage: {
+                    type: "isolated";
+                    value: number;
+                    rawUsd: string;
+                } | {
+                    type: "cross";
+                    value: number;
+                };
+                entryPx: string;
+                positionValue: string;
+                unrealizedPnl: string;
+                returnOnEquity: string;
+                liquidationPx: string | null;
+                marginUsed: string;
+                maxLeverage: number;
+                cumFunding: {
+                    allTime: string;
+                    sinceOpen: string;
+                    sinceChange: string;
+                };
+            }, "Position details.">]>;
+        }, undefined>, v.DescriptionAction<{
+            type: "oneWay";
+            position: {
+                coin: string;
+                szi: string;
+                leverage: {
+                    type: "isolated";
+                    value: number;
+                    rawUsd: string;
+                } | {
+                    type: "cross";
+                    value: number;
+                };
+                entryPx: string;
+                positionValue: string;
+                unrealizedPnl: string;
+                returnOnEquity: string;
+                liquidationPx: string | null;
+                marginUsed: string;
+                maxLeverage: number;
+                cumFunding: {
+                    allTime: string;
+                    sinceOpen: string;
+                    sinceChange: string;
+                };
+            };
+        }, "Position for a specific asset.">]>, undefined>, v.DescriptionAction<{
+            type: "oneWay";
+            position: {
+                coin: string;
+                szi: string;
+                leverage: {
+                    type: "isolated";
+                    value: number;
+                    rawUsd: string;
+                } | {
+                    type: "cross";
+                    value: number;
+                };
+                entryPx: string;
+                positionValue: string;
+                unrealizedPnl: string;
+                returnOnEquity: string;
+                liquidationPx: string | null;
+                marginUsed: string;
+                maxLeverage: number;
+                cumFunding: {
+                    allTime: string;
+                    sinceOpen: string;
+                    sinceChange: string;
+                };
+            };
+        }[], "Array of asset positions.">]>;
+        /** Timestamp when data was retrieved (in ms since epoch). */
+        readonly time: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Timestamp when data was retrieved (in ms since epoch).">]>;
+    }, undefined>, v.DescriptionAction<{
+        marginSummary: {
+            accountValue: string;
+            totalNtlPos: string;
+            totalRawUsd: string;
+            totalMarginUsed: string;
+        };
+        crossMarginSummary: {
+            accountValue: string;
+            totalNtlPos: string;
+            totalRawUsd: string;
+            totalMarginUsed: string;
+        };
+        crossMaintenanceMarginUsed: string;
+        withdrawable: string;
+        assetPositions: {
+            type: "oneWay";
+            position: {
+                coin: string;
+                szi: string;
+                leverage: {
+                    type: "isolated";
+                    value: number;
+                    rawUsd: string;
+                } | {
+                    type: "cross";
+                    value: number;
+                };
+                entryPx: string;
+                positionValue: string;
+                unrealizedPnl: string;
+                returnOnEquity: string;
+                liquidationPx: string | null;
+                marginUsed: string;
+                maxLeverage: number;
+                cumFunding: {
+                    allTime: string;
+                    sinceOpen: string;
+                    sinceChange: string;
+                };
+            };
+        }[];
+        time: number;
+    }, "Perpetual trading clearinghouse state summary.">]>;
+    /** Spot tokens clearinghouse state. */
+    readonly spotState: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Balance for each token. */
+        readonly balances: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Asset symbol. */
+            readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+            /** Unique identifier for the token. */
+            readonly token: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Unique identifier for the token.">]>;
+            /** Total balance. */
+            readonly total: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total balance.">]>;
+            /** Amount on hold. */
+            readonly hold: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Amount on hold.">]>;
+            /** Entry notional value. */
+            readonly entryNtl: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Entry notional value.">]>;
+        }, undefined>, v.DescriptionAction<{
+            coin: string;
+            token: number;
+            total: string;
+            hold: string;
+            entryNtl: string;
+        }, "Balance for a specific spot token.">]>, undefined>, v.DescriptionAction<{
+            coin: string;
+            token: number;
+            total: string;
+            hold: string;
+            entryNtl: string;
+        }[], "Balance for each token.">]>;
+        /** Escrowed balances. */
+        readonly evmEscrows: v.SchemaWithPipe<readonly [v.OptionalSchema<v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Asset symbol. */
+            readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+            /** Unique identifier for the token. */
+            readonly token: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Unique identifier for the token.">]>;
+            /** Total balance. */
+            readonly total: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total balance.">]>;
+        }, undefined>, v.DescriptionAction<{
+            coin: string;
+            token: number;
+            total: string;
+        }, "Escrowed balance for a specific asset.">]>, undefined>, undefined>, v.DescriptionAction<{
+            coin: string;
+            token: number;
+            total: string;
+        }[] | undefined, "Escrowed balances.">]>;
+    }, undefined>, v.DescriptionAction<{
+        balances: {
+            coin: string;
+            token: number;
+            total: string;
+            hold: string;
+            entryNtl: string;
+        }[];
+        evmEscrows?: {
+            coin: string;
+            token: number;
+            total: string;
+        }[] | undefined;
+    }, "Spot tokens clearinghouse state.">]>;
+}, undefined>, v.DescriptionAction<{
+    name: string;
+    subAccountUser: `0x${string}`;
+    master: `0x${string}`;
+    clearinghouseState: {
+        marginSummary: {
+            accountValue: string;
+            totalNtlPos: string;
+            totalRawUsd: string;
+            totalMarginUsed: string;
+        };
+        crossMarginSummary: {
+            accountValue: string;
+            totalNtlPos: string;
+            totalRawUsd: string;
+            totalMarginUsed: string;
+        };
+        crossMaintenanceMarginUsed: string;
+        withdrawable: string;
+        assetPositions: {
+            type: "oneWay";
+            position: {
+                coin: string;
+                szi: string;
+                leverage: {
+                    type: "isolated";
+                    value: number;
+                    rawUsd: string;
+                } | {
+                    type: "cross";
+                    value: number;
+                };
+                entryPx: string;
+                positionValue: string;
+                unrealizedPnl: string;
+                returnOnEquity: string;
+                liquidationPx: string | null;
+                marginUsed: string;
+                maxLeverage: number;
+                cumFunding: {
+                    allTime: string;
+                    sinceOpen: string;
+                    sinceChange: string;
+                };
+            };
+        }[];
+        time: number;
+    };
+    spotState: {
+        balances: {
+            coin: string;
+            token: number;
+            total: string;
+            hold: string;
+            entryNtl: string;
+        }[];
+        evmEscrows?: {
+            coin: string;
+            token: number;
+            total: string;
+        }[] | undefined;
+    };
+}, "Sub-account details for a user.">]>, undefined>, undefined>, v.DescriptionAction<{
+    name: string;
+    subAccountUser: `0x${string}`;
+    master: `0x${string}`;
+    clearinghouseState: {
+        marginSummary: {
+            accountValue: string;
+            totalNtlPos: string;
+            totalRawUsd: string;
+            totalMarginUsed: string;
+        };
+        crossMarginSummary: {
+            accountValue: string;
+            totalNtlPos: string;
+            totalRawUsd: string;
+            totalMarginUsed: string;
+        };
+        crossMaintenanceMarginUsed: string;
+        withdrawable: string;
+        assetPositions: {
+            type: "oneWay";
+            position: {
+                coin: string;
+                szi: string;
+                leverage: {
+                    type: "isolated";
+                    value: number;
+                    rawUsd: string;
+                } | {
+                    type: "cross";
+                    value: number;
+                };
+                entryPx: string;
+                positionValue: string;
+                unrealizedPnl: string;
+                returnOnEquity: string;
+                liquidationPx: string | null;
+                marginUsed: string;
+                maxLeverage: number;
+                cumFunding: {
+                    allTime: string;
+                    sinceOpen: string;
+                    sinceChange: string;
+                };
+            };
+        }[];
+        time: number;
+    };
+    spotState: {
+        balances: {
+            coin: string;
+            token: number;
+            total: string;
+            hold: string;
+            entryNtl: string;
+        }[];
+        evmEscrows?: {
+            coin: string;
+            token: number;
+            total: string;
+        }[] | undefined;
+    };
+}[] | null, "Array of user sub-account or null if the user does not have any sub-accounts.">]>;
+export type SubAccountsResponse = v.InferOutput<typeof SubAccountsResponse>;
+/** Request parameters for the {@linkcode subAccounts} function. */
+export type SubAccountsParameters = Omit<v.InferInput<typeof SubAccountsRequest>, "type">;
+/**
+ * Request user sub-accounts.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of user sub-account or null if the user does not have any sub-accounts.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { subAccounts } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await subAccounts(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export declare function subAccounts(config: InfoRequestConfig, params: DeepImmutable<SubAccountsParameters>, signal?: AbortSignal): Promise<SubAccountsResponse>;
+//# sourceMappingURL=subAccounts.d.ts.map

package/esm/src/api/info/subAccounts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subAccounts.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/subAccounts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAoB,KAAK,aAAa,EAA4C,MAAM,eAAe,CAAC;AAC/G,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,kBAAkB;IAGzB,uBAAuB;;IAKvB,oBAAoB;;;;;kCAQtB,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E;;;GAGG;AACH,eAAO,MAAM,mBAAmB;IAOpB,wBAAwB;;IAMxB,2BAA2B;;IAK3B,8BAA8B;;IAK9B,qDAAqD;;QAGjD,8BAA8B;;YAG1B,2BAA2B;;YAK3B,qCAAqC;;YAKrC,2BAA2B;;YAK3B,yBAAyB;;;;;;;;QAQ7B,oCAAoC;;YAGhC,2BAA2B;;YAK3B,qCAAqC;;YAKrC,2BAA2B;;YAK3B,yBAAyB;;;;;;;;QAQ7B,0DAA0D;;QAK1D,uCAAuC;;QAKvC,gCAAgC;;YAMxB,qBAAqB;;YAKrB,wBAAwB;;gBAGpB,oBAAoB;;gBAKpB,4BAA4B;;gBAK5B,wBAAwB;;oBAIlB,qBAAqB;;oBAKrB,2BAA2B;;oBAM3B,mCAAmC;;;oBAOnC,qBAAqB;;oBAKrB,2BAA2B;;;;;;;;;;gBAUjC,2BAA2B;;gBAK3B,sBAAsB;;gBAKtB,kCAAkC;;gBAKlC,wBAAwB;;gBAKxB,yBAAyB;;gBAKzB,mBAAmB;;gBAKnB,gCAAgC;;gBAMhC,kCAAkC;;oBAG9B,4DAA4D;;oBAK5D,yDAAyD;;oBAKzD,kEAAkE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAiBlF,6DAA6D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAQjE,uCAAuC;;QAGnC,8BAA8B;;YAMtB,oBAAoB;;YAKpB,uCAAuC;;YAKvC,qBAAqB;;YAKrB,sBAAsB;;YAKtB,4BAA4B;;;;;;;;;;;;;;;QAWpC,yBAAyB;;YAOf,oBAAoB;;YAKpB,uCAAuC;;YAKvC,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8FAsB3C,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAI5E,mEAAmE;AACnE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE1F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,qBAAqB,CAAC,EAC5C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,mBAAmB,CAAC,CAM9B"}

package/esm/src/api/info/subAccounts.js

@@ -0,0 +1,175 @@
+import * as v from "valibot";
+import { Address, Decimal, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+// -------------------- Schemas --------------------
+/**
+ * Request user sub-accounts.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
+ */
+export const SubAccountsRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("subAccounts"), v.description("Type of request.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+    }), v.description("Request user sub-accounts."));
+})();
+/**
+ * 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
+ */
+export const SubAccountsResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.nullable(v.array(
+    /** Sub-account details for a user. */
+    v.pipe(v.object({
+        /** Sub-account name. */
+        name: v.pipe(v.string(), v.minLength(1), v.description("Sub-account name.")),
+        /** Sub-account address. */
+        subAccountUser: v.pipe(Address, v.description("Sub-account address.")),
+        /** Master account address. */
+        master: v.pipe(Address, v.description("Master account address.")),
+        /** Perpetual trading clearinghouse state summary. */
+        clearinghouseState: v.pipe(v.object({
+            /** Margin summary details. */
+            marginSummary: v.pipe(v.object({
+                /** Total account value. */
+                accountValue: v.pipe(UnsignedDecimal, v.description("Total account value.")),
+                /** Total notional position value. */
+                totalNtlPos: v.pipe(UnsignedDecimal, v.description("Total notional position value.")),
+                /** Total raw USD value. */
+                totalRawUsd: v.pipe(UnsignedDecimal, v.description("Total raw USD value.")),
+                /** Total margin used. */
+                totalMarginUsed: v.pipe(UnsignedDecimal, v.description("Total margin used.")),
+            }), v.description("Margin summary details.")),
+            /** Cross-margin summary details. */
+            crossMarginSummary: v.pipe(v.object({
+                /** Total account value. */
+                accountValue: v.pipe(UnsignedDecimal, v.description("Total account value.")),
+                /** Total notional position value. */
+                totalNtlPos: v.pipe(UnsignedDecimal, v.description("Total notional position value.")),
+                /** Total raw USD value. */
+                totalRawUsd: v.pipe(UnsignedDecimal, v.description("Total raw USD value.")),
+                /** Total margin used. */
+                totalMarginUsed: v.pipe(UnsignedDecimal, v.description("Total margin used.")),
+            }), v.description("Cross-margin summary details.")),
+            /** Maintenance margin used for cross-margin positions. */
+            crossMaintenanceMarginUsed: v.pipe(UnsignedDecimal, v.description("Maintenance margin used for cross-margin positions.")),
+            /** Amount available for withdrawal. */
+            withdrawable: v.pipe(UnsignedDecimal, v.description("Amount available for withdrawal.")),
+            /** Array of asset positions. */
+            assetPositions: v.pipe(v.array(
+            /** Position for a specific asset. */
+            v.pipe(v.object({
+                /** Position type. */
+                type: v.pipe(v.literal("oneWay"), v.description("Position type.")),
+                /** Position details. */
+                position: v.pipe(v.object({
+                    /** Asset symbol. */
+                    coin: v.pipe(v.string(), v.description("Asset symbol.")),
+                    /** Signed position size. */
+                    szi: v.pipe(Decimal, v.description("Signed position size.")),
+                    /** Leverage details. */
+                    leverage: v.pipe(v.union([
+                        v.object({
+                            /** Leverage type. */
+                            type: v.pipe(v.literal("isolated"), v.description("Leverage type.")),
+                            /** Leverage value used. */
+                            value: v.pipe(UnsignedInteger, v.minValue(1), v.description("Leverage value used.")),
+                            /** Amount of USD used (1 = 1$). */
+                            rawUsd: v.pipe(UnsignedDecimal, v.description("Amount of USD used (1 = 1$).")),
+                        }),
+                        v.object({
+                            /** Leverage type. */
+                            type: v.pipe(v.literal("cross"), v.description("Leverage type.")),
+                            /** Leverage value used. */
+                            value: v.pipe(UnsignedInteger, v.minValue(1), v.description("Leverage value used.")),
+                        }),
+                    ]), v.description("Leverage details.")),
+                    /** Average entry price. */
+                    entryPx: v.pipe(UnsignedDecimal, v.description("Average entry price.")),
+                    /** Position value. */
+                    positionValue: v.pipe(UnsignedDecimal, v.description("Position value.")),
+                    /** Unrealized profit and loss. */
+                    unrealizedPnl: v.pipe(Decimal, v.description("Unrealized profit and loss.")),
+                    /** Return on equity. */
+                    returnOnEquity: v.pipe(Decimal, v.description("Return on equity.")),
+                    /** Liquidation price. */
+                    liquidationPx: v.pipe(v.union([UnsignedDecimal, v.null()]), v.description("Liquidation price.")),
+                    /** Margin used. */
+                    marginUsed: v.pipe(UnsignedDecimal, v.description("Margin used.")),
+                    /** Maximum allowed leverage. */
+                    maxLeverage: v.pipe(UnsignedInteger, v.minValue(1), v.description("Maximum allowed leverage.")),
+                    /** Cumulative funding details. */
+                    cumFunding: v.pipe(v.object({
+                        /** Total funding paid or received since account opening. */
+                        allTime: v.pipe(Decimal, v.description("Total funding paid or received since account opening.")),
+                        /** Funding accumulated since the position was opened. */
+                        sinceOpen: v.pipe(Decimal, v.description("Funding accumulated since the position was opened.")),
+                        /** Funding accumulated since the last change in position size. */
+                        sinceChange: v.pipe(Decimal, v.description("Funding accumulated since the last change in position size.")),
+                    }), v.description("Cumulative funding details.")),
+                }), v.description("Position details.")),
+            }), v.description("Position for a specific asset."))), v.description("Array of asset positions.")),
+            /** Timestamp when data was retrieved (in ms since epoch). */
+            time: v.pipe(UnsignedInteger, v.description("Timestamp when data was retrieved (in ms since epoch).")),
+        }), v.description("Perpetual trading clearinghouse state summary.")),
+        /** Spot tokens clearinghouse state. */
+        spotState: v.pipe(v.object({
+            /** Balance for each token. */
+            balances: v.pipe(v.array(
+            /** Balance for a specific spot token. */
+            v.pipe(v.object({
+                /** Asset symbol. */
+                coin: v.pipe(v.string(), v.description("Asset symbol.")),
+                /** Unique identifier for the token. */
+                token: v.pipe(UnsignedInteger, v.description("Unique identifier for the token.")),
+                /** Total balance. */
+                total: v.pipe(UnsignedDecimal, v.description("Total balance.")),
+                /** Amount on hold. */
+                hold: v.pipe(UnsignedDecimal, v.description("Amount on hold.")),
+                /** Entry notional value. */
+                entryNtl: v.pipe(UnsignedDecimal, v.description("Entry notional value.")),
+            }), v.description("Balance for a specific spot token."))), v.description("Balance for each token.")),
+            /** Escrowed balances. */
+            evmEscrows: v.pipe(v.optional(v.array(
+            /** Escrowed balance for a specific asset. */
+            v.pipe(v.object({
+                /** Asset symbol. */
+                coin: v.pipe(v.string(), v.description("Asset symbol.")),
+                /** Unique identifier for the token. */
+                token: v.pipe(UnsignedInteger, v.description("Unique identifier for the token.")),
+                /** Total balance. */
+                total: v.pipe(UnsignedDecimal, v.description("Total balance.")),
+            }), v.description("Escrowed balance for a specific asset.")))), v.description("Escrowed balances.")),
+        }), v.description("Spot tokens clearinghouse state.")),
+    }), v.description("Sub-account details for a user.")))), v.description("Array of user sub-account or null if the user does not have any sub-accounts."));
+})();
+/**
+ * Request user sub-accounts.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of user sub-account or null if the user does not have any sub-accounts.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { subAccounts } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await subAccounts(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function subAccounts(config, params, signal) {
+    const request = parser(SubAccountsRequest)({
+        type: "subAccounts",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=subAccounts.js.map