@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.0

package/esm/src/api/info/perpDeployAuctionStatus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"perpDeployAuctionStatus.js","sourceRoot":"","sources":["../../../../src/src/api/info/perpDeployAuctionStatus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAGzE,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAClE,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,yBAAyB,CAAC,EACpC,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yDAAyD,CAAC,CACzE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACnE,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,mBAAmB;QACnB,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;QACD,2BAA2B;QAC3B,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;QACD,kBAAkB;QAClB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;QACD,oBAAoB;QACpB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,gDAAgD;QAChD,gBAAgB,EAAE,CAAC,CAAC,IAAI,CACtB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yCAAyC,CAAC,CACzD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,qDAAqD;AAErD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,uBAAuB,CACrC,MAAyB,EACzB,MAAoB;IAEpB,MAAM,OAAO,GAAG,MAAM,CAAC,8BAA8B,CAAC,CAAC;QACrD,IAAI,EAAE,yBAAyB;KAChC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

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

@@ -0,0 +1,63 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request builder deployed perpetual market limits.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
+ */
+export declare const PerpDexLimitsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDexLimits", undefined>, v.DescriptionAction<"perpDexLimits", "Type of request.">]>;
+    /** DEX name (empty string for main dex). */
+    readonly dex: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "DEX name (empty string for main dex).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "perpDexLimits";
+    dex: string;
+}, "Request builder deployed perpetual market limits.">]>;
+export type PerpDexLimitsRequest = v.InferOutput<typeof PerpDexLimitsRequest>;
+/**
+ * Builder deployed perpetual market limits.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
+ */
+export declare const PerpDexLimitsResponse: v.SchemaWithPipe<readonly [v.NullableSchema<v.ObjectSchema<{
+    /** Total open interest cap. */
+    readonly totalOiCap: 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 open interest cap.">]>;
+    /** Open interest size cap per perpetual. */
+    readonly oiSzCapPerPerp: 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, "Open interest size cap per perpetual.">]>;
+    /** Maximum transfer notional amount. */
+    readonly maxTransferNtl: 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, "Maximum transfer notional amount.">]>;
+    /** Coin to open interest cap mapping. */
+    readonly coinToOiCap: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[v.StringSchema<undefined>, 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>]>], undefined>, undefined>, v.DescriptionAction<[string, string][], "Coin to open interest cap mapping.">]>;
+}, undefined>, undefined>, v.DescriptionAction<{
+    totalOiCap: string;
+    oiSzCapPerPerp: string;
+    maxTransferNtl: string;
+    coinToOiCap: [string, string][];
+} | null, "Builder deployed perpetual market limits.">]>;
+export type PerpDexLimitsResponse = v.InferOutput<typeof PerpDexLimitsResponse>;
+/** Request parameters for the {@linkcode perpDexLimits} function. */
+export type PerpDexLimitsParameters = Omit<v.InferInput<typeof PerpDexLimitsRequest>, "type">;
+/**
+ * Request builder deployed perpetual market limits.
+ * @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 Builder deployed perpetual market limits.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { perpDexLimits } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await perpDexLimits(
+ *   { transport },
+ *   { dex: "test" },
+ * );
+ * ```
+ */
+export declare function perpDexLimits(config: InfoRequestConfig, params: DeepImmutable<PerpDexLimitsParameters>, signal?: AbortSignal): Promise<PerpDexLimitsResponse>;
+//# sourceMappingURL=perpDexLimits.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"perpDexLimits.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/perpDexLimits.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,KAAK,aAAa,EAA2B,MAAM,eAAe,CAAC;AAC5E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,oBAAoB;IAG3B,uBAAuB;;IAKvB,4CAA4C;;;;;yDAQ9C,CAAC;AACL,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAE9E;;;GAGG;AACH,eAAO,MAAM,qBAAqB;IAI1B,+BAA+B;;IAK/B,4CAA4C;;IAK5C,wCAAwC;;IAKxC,yCAAyC;;;;;;;wDAS7C,CAAC;AACL,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAIhF,qEAAqE;AACrE,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,oBAAoB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE9F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC9C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,qBAAqB,CAAC,CAMhC"}

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

@@ -0,0 +1,61 @@
+import * as v from "valibot";
+import { parser, UnsignedDecimal } from "../_common.js";
+// -------------------- Schemas --------------------
+/**
+ * Request builder deployed perpetual market limits.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
+ */
+export const PerpDexLimitsRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("perpDexLimits"), v.description("Type of request.")),
+        /** DEX name (empty string for main dex). */
+        dex: v.pipe(v.string(), v.description("DEX name (empty string for main dex).")),
+    }), v.description("Request builder deployed perpetual market limits."));
+})();
+/**
+ * Builder deployed perpetual market limits.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
+ */
+export const PerpDexLimitsResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.nullable(v.object({
+        /** Total open interest cap. */
+        totalOiCap: v.pipe(UnsignedDecimal, v.description("Total open interest cap.")),
+        /** Open interest size cap per perpetual. */
+        oiSzCapPerPerp: v.pipe(UnsignedDecimal, v.description("Open interest size cap per perpetual.")),
+        /** Maximum transfer notional amount. */
+        maxTransferNtl: v.pipe(UnsignedDecimal, v.description("Maximum transfer notional amount.")),
+        /** Coin to open interest cap mapping. */
+        coinToOiCap: v.pipe(v.array(v.tuple([v.string(), UnsignedDecimal])), v.description("Coin to open interest cap mapping.")),
+    })), v.description("Builder deployed perpetual market limits."));
+})();
+/**
+ * Request builder deployed perpetual market limits.
+ * @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 Builder deployed perpetual market limits.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { perpDexLimits } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await perpDexLimits(
+ *   { transport },
+ *   { dex: "test" },
+ * );
+ * ```
+ */
+export function perpDexLimits(config, params, signal) {
+    const request = parser(PerpDexLimitsRequest)({
+        type: "perpDexLimits",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=perpDexLimits.js.map

package/esm/src/api/info/perpDexLimits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"perpDexLimits.js","sourceRoot":"","sources":["../../../../src/src/api/info/perpDexLimits.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAsB,MAAM,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAG5E,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACxD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,EAC1B,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,4CAA4C;QAC5C,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,mDAAmD,CAAC,CACnE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACzD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,QAAQ,CACR,CAAC,CAAC,MAAM,CAAC;QACP,+BAA+B;QAC/B,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;QACD,4CAA4C;QAC5C,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;QACD,wCAAwC;QACxC,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,mCAAmC,CAAC,CACnD;QACD,yCAAyC;QACzC,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,eAAe,CAAC,CAAC,CAAC,EAC/C,CAAC,CAAC,WAAW,CAAC,oCAAoC,CAAC,CACpD;KACF,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAyB,EACzB,MAA8C,EAC9C,MAAoB;IAEpB,MAAM,OAAO,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC;QAC3C,IAAI,EAAE,eAAe;QACrB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

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

@@ -0,0 +1,58 @@
+import * as v from "valibot";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request all perpetual dexs.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
+ */
+export declare const PerpDexsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDexs", undefined>, v.DescriptionAction<"perpDexs", "Type of request.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "perpDexs";
+}, "Request all perpetual dexs.">]>;
+export type PerpDexsRequest = v.InferOutput<typeof PerpDexsRequest>;
+/**
+ * Array of perpetual dexes (null is main dex).
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
+ */
+export declare const PerpDexsResponse: v.SchemaWithPipe<readonly [v.ArraySchema<v.NullableSchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Short name of the perpetual dex. */
+    readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Short name of the perpetual dex.">]>;
+    /** Complete name of the perpetual dex. */
+    readonly full_name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Complete name of the perpetual dex.">]>;
+    /** Hex address of the dex deployer. */
+    readonly deployer: 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}`, "Hex address of the dex deployer.">]>;
+    /** Hex address of the oracle updater, or null if not available. */
+    readonly oracle_updater: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, undefined>, v.DescriptionAction<`0x${string}` | null, "Hex address of the oracle updater, or null if not available.">]>;
+}, undefined>, v.DescriptionAction<{
+    name: string;
+    full_name: string;
+    deployer: `0x${string}`;
+    oracle_updater: `0x${string}` | null;
+}, " Perpetual dex metadata.">]>, undefined>, undefined>, v.DescriptionAction<({
+    name: string;
+    full_name: string;
+    deployer: `0x${string}`;
+    oracle_updater: `0x${string}` | null;
+} | null)[], "Array of perpetual dexes (null is main dex).">]>;
+export type PerpDexsResponse = v.InferOutput<typeof PerpDexsResponse>;
+/**
+ * Request all perpetual dexs.
+ * @param config - General configuration for Info API requests.
+ * @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 perpetual dexes (null is main dex).
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { perpDexs } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await perpDexs({ transport });
+ * ```
+ */
+export declare function perpDexs(config: InfoRequestConfig, signal?: AbortSignal): Promise<PerpDexsResponse>;
+//# sourceMappingURL=perpDexs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"perpDexs.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/perpDexs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,eAAe;IAGtB,uBAAuB;;;;mCAQzB,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAOjB,uCAAuC;;IAKvC,0CAA0C;;IAK1C,uCAAuC;;IAKvC,mEAAmE;;;;;;;;;;;;8DAY3E,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAItE;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,iBAAiB,EACzB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,gBAAgB,CAAC,CAK3B"}

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

@@ -0,0 +1,57 @@
+import * as v from "valibot";
+import { Address, parser } from "../_common.js";
+// -------------------- Schemas --------------------
+/**
+ * Request all perpetual dexs.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
+ */
+export const PerpDexsRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("perpDexs"), v.description("Type of request.")),
+    }), v.description("Request all perpetual dexs."));
+})();
+/**
+ * Array of perpetual dexes (null is main dex).
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
+ */
+export const PerpDexsResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.array(v.nullable(
+    /** Perpetual dex metadata. */
+    v.pipe(v.object({
+        /** Short name of the perpetual dex. */
+        name: v.pipe(v.string(), v.description("Short name of the perpetual dex.")),
+        /** Complete name of the perpetual dex. */
+        full_name: v.pipe(v.string(), v.description("Complete name of the perpetual dex.")),
+        /** Hex address of the dex deployer. */
+        deployer: v.pipe(Address, v.description("Hex address of the dex deployer.")),
+        /** Hex address of the oracle updater, or null if not available. */
+        oracle_updater: v.pipe(v.nullable(Address), v.description("Hex address of the oracle updater, or null if not available.")),
+    }), v.description(" Perpetual dex metadata.")))), v.description("Array of perpetual dexes (null is main dex)."));
+})();
+// -------------------- Function --------------------
+/**
+ * Request all perpetual dexs.
+ * @param config - General configuration for Info API requests.
+ * @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 perpetual dexes (null is main dex).
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { perpDexs } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await perpDexs({ transport });
+ * ```
+ */
+export function perpDexs(config, signal) {
+    const request = parser(PerpDexsRequest)({
+        type: "perpDexs",
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=perpDexs.js.map

package/esm/src/api/info/perpDexs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"perpDexs.js","sourceRoot":"","sources":["../../../../src/src/api/info/perpDexs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAGhD,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACnD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EACrB,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACpD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,QAAQ;IACR,8BAA8B;IAC9B,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,uCAAuC;QACvC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;QACD,0CAA0C;QAC1C,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,qCAAqC,CAAC,CACrD;QACD,uCAAuC;QACvC,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;QACD,mEAAmE;QACnE,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,8DAA8D,CAAC,CAC9E;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C,CACF,CACF,EACD,CAAC,CAAC,WAAW,CAAC,8CAA8C,CAAC,CAC9D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,qDAAqD;AAErD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,QAAQ,CACtB,MAAyB,EACzB,MAAoB;IAEpB,MAAM,OAAO,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC;QACtC,IAAI,EAAE,UAAU;KACjB,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

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

@@ -0,0 +1,47 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request perpetuals at open interest cap.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
+ */
+export declare const PerpsAtOpenInterestCapRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpsAtOpenInterestCap", undefined>, v.DescriptionAction<"perpsAtOpenInterestCap", "Type of request.">]>;
+    /** DEX name (empty string for main dex). */
+    readonly dex: v.SchemaWithPipe<readonly [v.OptionalSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | undefined, "DEX name (empty string for main dex).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "perpsAtOpenInterestCap";
+    dex?: string | undefined;
+}, "Request perpetuals at open interest cap.">]>;
+export type PerpsAtOpenInterestCapRequest = v.InferOutput<typeof PerpsAtOpenInterestCapRequest>;
+/**
+ * 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
+ */
+export declare const PerpsAtOpenInterestCapResponse: v.SchemaWithPipe<readonly [v.ArraySchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string[], "Array of perpetuals at open interest caps.">]>;
+export type PerpsAtOpenInterestCapResponse = v.InferOutput<typeof PerpsAtOpenInterestCapResponse>;
+/** Request parameters for the {@linkcode perpsAtOpenInterestCap} function. */
+export type PerpsAtOpenInterestCapParameters = Omit<v.InferInput<typeof PerpsAtOpenInterestCapRequest>, "type">;
+/**
+ * Request perpetuals at open interest cap.
+ * @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 perpetuals at open interest caps.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { perpsAtOpenInterestCap } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await perpsAtOpenInterestCap({ transport });
+ * ```
+ */
+export declare function perpsAtOpenInterestCap(config: InfoRequestConfig, params?: DeepImmutable<PerpsAtOpenInterestCapParameters>, signal?: AbortSignal): Promise<PerpsAtOpenInterestCapResponse>;
+export declare function perpsAtOpenInterestCap(config: InfoRequestConfig, signal?: AbortSignal): Promise<PerpsAtOpenInterestCapResponse>;
+//# sourceMappingURL=perpsAtOpenInterestCap.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"perpsAtOpenInterestCap.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/perpsAtOpenInterestCap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,KAAK,aAAa,EAAU,MAAM,eAAe,CAAC;AAC3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,6BAA6B;IAGpC,uBAAuB;;IAKvB,4CAA4C;;;;;gDAQ9C,CAAC;AACL,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEhG;;;GAGG;AACH,eAAO,MAAM,8BAA8B,+JAKvC,CAAC;AACL,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAIlG,8EAA8E;AAC9E,MAAM,MAAM,gCAAgC,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,6BAA6B,CAAC,EAAE,MAAM,CAAC,CAAC;AAEhH;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,iBAAiB,EACzB,MAAM,CAAC,EAAE,aAAa,CAAC,gCAAgC,CAAC,EACxD,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,8BAA8B,CAAC,CAAC;AAC3C,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,iBAAiB,EACzB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,8BAA8B,CAAC,CAAC"}

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

@@ -0,0 +1,32 @@
+import * as v from "valibot";
+import { parser } from "../_common.js";
+// -------------------- Schemas --------------------
+/**
+ * Request perpetuals at open interest cap.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
+ */
+export const PerpsAtOpenInterestCapRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("perpsAtOpenInterestCap"), v.description("Type of request.")),
+        /** DEX name (empty string for main dex). */
+        dex: v.pipe(v.optional(v.string()), v.description("DEX name (empty string for main dex).")),
+    }), v.description("Request perpetuals at open interest cap."));
+})();
+/**
+ * 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
+ */
+export const PerpsAtOpenInterestCapResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.array(v.string()), v.description("Array of perpetuals at open interest caps."));
+})();
+export function perpsAtOpenInterestCap(config, paramsOrSignal, maybeSignal) {
+    const params = paramsOrSignal instanceof AbortSignal ? {} : paramsOrSignal;
+    const signal = paramsOrSignal instanceof AbortSignal ? paramsOrSignal : maybeSignal;
+    const request = parser(PerpsAtOpenInterestCapRequest)({
+        type: "perpsAtOpenInterestCap",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=perpsAtOpenInterestCap.js.map

package/esm/src/api/info/perpsAtOpenInterestCap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"perpsAtOpenInterestCap.js","sourceRoot":"","sources":["../../../../src/src/api/info/perpsAtOpenInterestCap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAsB,MAAM,EAAE,MAAM,eAAe,CAAC;AAG3D,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACjE,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,EACnC,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,4CAA4C;QAC5C,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAC1D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAClE,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,4CAA4C,CAAC,CAC5D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAoCL,MAAM,UAAU,sBAAsB,CACpC,MAAyB,EACzB,cAA8E,EAC9E,WAAyB;IAEzB,MAAM,MAAM,GAAG,cAAc,YAAY,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC;IAC3E,MAAM,MAAM,GAAG,cAAc,YAAY,WAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,WAAW,CAAC;IAEpF,MAAM,OAAO,GAAG,MAAM,CAAC,6BAA6B,CAAC,CAAC;QACpD,IAAI,EAAE,wBAAwB;QAC9B,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

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

@@ -0,0 +1,169 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request user portfolio.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
+ */
+export declare const PortfolioRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"portfolio", undefined>, v.DescriptionAction<"portfolio", "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: "portfolio";
+    user: `0x${string}`;
+}, "Request user portfolio.">]>;
+export type PortfolioRequest = v.InferOutput<typeof PortfolioRequest>;
+/**
+ * Portfolio metrics grouped by time periods.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
+ */
+export declare const PortfolioResponse: v.SchemaWithPipe<readonly [v.TupleSchema<[v.TupleSchema<[v.LiteralSchema<"day", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** History entries for account value as [timestamp, value]. */
+    readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss as [timestamp, value]. */
+    readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: 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, "Volume metric for the portfolio.">]>;
+}, undefined>, v.DescriptionAction<{
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}, "Portfolio metrics snapshot.">]>], undefined>, v.TupleSchema<[v.LiteralSchema<"week", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** History entries for account value as [timestamp, value]. */
+    readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss as [timestamp, value]. */
+    readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: 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, "Volume metric for the portfolio.">]>;
+}, undefined>, v.DescriptionAction<{
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}, "Portfolio metrics snapshot.">]>], undefined>, v.TupleSchema<[v.LiteralSchema<"month", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** History entries for account value as [timestamp, value]. */
+    readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss as [timestamp, value]. */
+    readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: 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, "Volume metric for the portfolio.">]>;
+}, undefined>, v.DescriptionAction<{
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}, "Portfolio metrics snapshot.">]>], undefined>, v.TupleSchema<[v.LiteralSchema<"allTime", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** History entries for account value as [timestamp, value]. */
+    readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss as [timestamp, value]. */
+    readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: 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, "Volume metric for the portfolio.">]>;
+}, undefined>, v.DescriptionAction<{
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}, "Portfolio metrics snapshot.">]>], undefined>, v.TupleSchema<[v.LiteralSchema<"perpDay", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** History entries for account value as [timestamp, value]. */
+    readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss as [timestamp, value]. */
+    readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: 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, "Volume metric for the portfolio.">]>;
+}, undefined>, v.DescriptionAction<{
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}, "Portfolio metrics snapshot.">]>], undefined>, v.TupleSchema<[v.LiteralSchema<"perpWeek", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** History entries for account value as [timestamp, value]. */
+    readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss as [timestamp, value]. */
+    readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: 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, "Volume metric for the portfolio.">]>;
+}, undefined>, v.DescriptionAction<{
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}, "Portfolio metrics snapshot.">]>], undefined>, v.TupleSchema<[v.LiteralSchema<"perpMonth", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** History entries for account value as [timestamp, value]. */
+    readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss as [timestamp, value]. */
+    readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: 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, "Volume metric for the portfolio.">]>;
+}, undefined>, v.DescriptionAction<{
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}, "Portfolio metrics snapshot.">]>], undefined>, v.TupleSchema<[v.LiteralSchema<"perpAllTime", undefined>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** History entries for account value as [timestamp, value]. */
+    readonly accountValueHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for account value as [timestamp, value].">]>;
+    /** History entries for profit and loss as [timestamp, value]. */
+    readonly pnlHistory: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "History entries for profit and loss as [timestamp, value].">]>;
+    /** Volume metric for the portfolio. */
+    readonly vlm: 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, "Volume metric for the portfolio.">]>;
+}, undefined>, v.DescriptionAction<{
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}, "Portfolio metrics snapshot.">]>], undefined>], undefined>, v.DescriptionAction<[["day", {
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}], ["week", {
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}], ["month", {
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}], ["allTime", {
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}], ["perpDay", {
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}], ["perpWeek", {
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}], ["perpMonth", {
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}], ["perpAllTime", {
+    accountValueHistory: [number, string][];
+    pnlHistory: [number, string][];
+    vlm: string;
+}]], "Portfolio metrics grouped by time periods.">]>;
+export type PortfolioResponse = v.InferOutput<typeof PortfolioResponse>;
+/** Request parameters for the {@linkcode portfolio} function. */
+export type PortfolioParameters = Omit<v.InferInput<typeof PortfolioRequest>, "type">;
+/**
+ * Request user portfolio.
+ * @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 Portfolio metrics grouped by time periods.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { portfolio } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await portfolio(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export declare function portfolio(config: InfoRequestConfig, params: DeepImmutable<PortfolioParameters>, signal?: AbortSignal): Promise<PortfolioResponse>;
+//# sourceMappingURL=portfolio.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"portfolio.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/portfolio.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,gBAAgB;IAGvB,uBAAuB;;IAKvB,oBAAoB;;;;;+BAQtB,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AA2BtE;;;GAGG;AACH,eAAO,MAAM,iBAAiB;IAzBxB,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;IAVvC,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;IAVvC,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;IAVvC,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;IAVvC,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;IAVvC,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;IAVvC,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;IAVvC,+DAA+D;;IAK/D,iEAAiE;;IAKjE,uCAAuC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oDA6BzC,CAAC;AACL,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAIxE,iEAAiE;AACjE,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,EAAE,MAAM,CAAC,CAAC;AAEtF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,mBAAmB,CAAC,EAC1C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,iBAAiB,CAAC,CAM5B"}