@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.1

package/src/src/api/info/historicalOrders.ts

@@ -0,0 +1,278 @@
+import * as v from "valibot";
+import { Address, type DeepImmutable, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request user historical orders.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
+ */
+export const HistoricalOrdersRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("historicalOrders"),
+        v.description("Type of request."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+    }),
+    v.description("Request user historical orders."),
+  );
+})();
+export type HistoricalOrdersRequest = v.InferOutput<typeof HistoricalOrdersRequest>;
+
+/**
+ * Array of frontend orders with current processing status.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
+ */
+export const HistoricalOrdersResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.array(
+      /** Frontend order with current processing status. */
+      v.pipe(
+        v.object({
+          /** Order details. */
+          order: v.pipe(
+            v.object({
+              /** Asset symbol. */
+              coin: v.pipe(
+                v.string(),
+                v.description("Asset symbol."),
+              ),
+              /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
+              side: v.pipe(
+                v.union([v.literal("B"), v.literal("A")]),
+                v.description('Order side ("B" = Bid/Buy, "A" = Ask/Sell).'),
+              ),
+              /** Limit price. */
+              limitPx: v.pipe(
+                UnsignedDecimal,
+                v.description("Limit price."),
+              ),
+              /** Size. */
+              sz: v.pipe(
+                UnsignedDecimal,
+                v.description("Size."),
+              ),
+              /** Order ID. */
+              oid: v.pipe(
+                UnsignedInteger,
+                v.description("Order ID."),
+              ),
+              /** Timestamp when the order was placed (in ms since epoch). */
+              timestamp: v.pipe(
+                UnsignedInteger,
+                v.description("Timestamp when the order was placed (in ms since epoch)."),
+              ),
+              /** Original size at order placement. */
+              origSz: v.pipe(
+                UnsignedDecimal,
+                v.description("Original size at order placement."),
+              ),
+              /** Condition for triggering the order. */
+              triggerCondition: v.pipe(
+                v.string(),
+                v.description("Condition for triggering the order."),
+              ),
+              /** Indicates if the order is a trigger order. */
+              isTrigger: v.pipe(
+                v.boolean(),
+                v.description("Indicates if the order is a trigger order."),
+              ),
+              /** Trigger price. */
+              triggerPx: v.pipe(
+                UnsignedDecimal,
+                v.description("Trigger price."),
+              ),
+              /** Child orders associated with this order. */
+              children: v.pipe(
+                // deno-lint-ignore no-explicit-any
+                v.array(v.lazy<any>(() => HistoricalOrdersResponse.item.entries.order)),
+                v.description("Child orders associated with this order."),
+              ),
+              /** Indicates if the order is a position TP/SL order. */
+              isPositionTpsl: v.pipe(
+                v.boolean(),
+                v.description("Indicates if the order is a position TP/SL order."),
+              ),
+              /** Indicates whether the order is reduce-only. */
+              reduceOnly: v.pipe(
+                v.boolean(),
+                v.description("Indicates whether the order is reduce-only."),
+              ),
+              /**
+               * Order type for market execution.
+               * - `"Market"`: Executes immediately at the market price.
+               * - `"Limit"`: Executes at the specified limit price or better.
+               * - `"Stop Market"`: Activates as a market order when a stop price is reached.
+               * - `"Stop Limit"`: Activates as a limit order when a stop price is reached.
+               * - `"Take Profit Market"`: Executes as a market order when a take profit price is reached.
+               * - `"Take Profit Limit"`: Executes as a limit order when a take profit price is reached.
+               * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/order-types
+               */
+              orderType: v.pipe(
+                v.union([
+                  v.literal("Market"),
+                  v.literal("Limit"),
+                  v.literal("Stop Market"),
+                  v.literal("Stop Limit"),
+                  v.literal("Take Profit Market"),
+                  v.literal("Take Profit Limit"),
+                ]),
+                v.description(
+                  "Order type for market execution." +
+                    '\n- `"Market"`: Executes immediately at the market price. ' +
+                    '\n- `"Limit"`: Executes at the specified limit price or better. ' +
+                    '\n- `"Stop Market"`: Activates as a market order when a stop price is reached. ' +
+                    '\n- `"Stop Limit"`: Activates as a limit order when a stop price is reached. ' +
+                    '\n- `"Take Profit Market"`: Executes as a market order when a take profit price is reached. ' +
+                    '\n- `"Take Profit Limit"`: Executes as a limit order when a take profit price is reached. ',
+                ),
+              ),
+              /**
+               * Time-in-force options.
+               * - `"Gtc"`: Remains active until filled or canceled.
+               * - `"Ioc"`: Fills immediately or cancels any unfilled portion.
+               * - `"Alo"`: Adds liquidity only.
+               * - `"FrontendMarket"`: Similar to Ioc, used in Hyperliquid UI.
+               * - `"LiquidationMarket"`: Similar to Ioc, used in Hyperliquid UI.
+               */
+              tif: v.pipe(
+                v.union([
+                  v.union([
+                    v.literal("Gtc"),
+                    v.literal("Ioc"),
+                    v.literal("Alo"),
+                    v.literal("FrontendMarket"),
+                    v.literal("LiquidationMarket"),
+                  ]),
+                  v.null(),
+                ]),
+                v.description(
+                  "Time-in-force options." +
+                    '\n- `"Gtc"`: Remains active until filled or canceled. ' +
+                    '\n- `"Ioc"`: Fills immediately or cancels any unfilled portion. ' +
+                    '\n- `"Alo"`: Adds liquidity only. ' +
+                    '\n- `"FrontendMarket"`: Similar to Ioc, used in Hyperliquid UI. ' +
+                    '\n- `"LiquidationMarket"`: Similar to Ioc, used in Hyperliquid UI.',
+                ),
+              ),
+              /** Client Order ID. */
+              cloid: v.pipe(
+                v.union([v.pipe(Hex, v.length(34)), v.null()]),
+                v.description("Client Order ID."),
+              ),
+            }),
+            v.description("Order details."),
+          ),
+          /**
+           * Order processing status.
+           * - `"open"`: Order active and waiting to be filled.
+           * - `"filled"`: Order fully executed.
+           * - `"canceled"`: Order canceled by the user.
+           * - `"triggered"`: Order triggered and awaiting execution.
+           * - `"rejected"`: Order rejected by the system.
+           * - `"marginCanceled"`: Order canceled due to insufficient margin.
+           * - `"vaultWithdrawalCanceled"`: Canceled due to a user withdrawal from vault.
+           * - `"openInterestCapCanceled"`: Canceled due to order being too aggressive when open interest was at cap.
+           * - `"selfTradeCanceled"`: Canceled due to self-trade prevention.
+           * - `"reduceOnlyCanceled"`: Canceled reduced-only order that does not reduce position.
+           * - `"siblingFilledCanceled"`: Canceled due to sibling ordering being filled.
+           * - `"delistedCanceled"`: Canceled due to asset delisting.
+           * - `"liquidatedCanceled"`: Canceled due to liquidation.
+           * - `"scheduledCancel"`: Canceled due to exceeding scheduled cancel deadline (dead man's switch).
+           */
+          status: v.pipe(
+            v.union([
+              v.literal("open"),
+              v.literal("filled"),
+              v.literal("canceled"),
+              v.literal("triggered"),
+              v.literal("rejected"),
+              v.literal("marginCanceled"),
+              v.literal("vaultWithdrawalCanceled"),
+              v.literal("openInterestCapCanceled"),
+              v.literal("selfTradeCanceled"),
+              v.literal("reduceOnlyCanceled"),
+              v.literal("siblingFilledCanceled"),
+              v.literal("delistedCanceled"),
+              v.literal("liquidatedCanceled"),
+              v.literal("scheduledCancel"),
+              v.literal("reduceOnlyRejected"),
+            ]),
+            v.description(
+              "Order processing status." +
+                '\n- `"open"`: Order active and waiting to be filled. ' +
+                '\n- `"filled"`: Order fully executed. ' +
+                '\n- `"canceled"`: Order canceled by the user. ' +
+                '\n- `"triggered"`: Order triggered and awaiting execution. ' +
+                '\n- `"rejected"`: Order rejected by the system. ' +
+                '\n- `"marginCanceled"`: Order canceled due to insufficient margin. ' +
+                '\n- `"vaultWithdrawalCanceled"`: Canceled due to a user withdrawal from vault. ' +
+                '\n- `"openInterestCapCanceled"`: Canceled due to order being too aggressive when open interest was at cap. ' +
+                '\n- `"selfTradeCanceled"`: Canceled due to self-trade prevention. ' +
+                '\n- `"reduceOnlyCanceled"`: Canceled reduced-only order that does not reduce position. ' +
+                '\n- `"siblingFilledCanceled"`: Canceled due to sibling ordering being filled. ' +
+                '\n- `"delistedCanceled"`: Canceled due to asset delisting. ' +
+                '\n- `"liquidatedCanceled"`: Canceled due to liquidation. ' +
+                '\n- `"scheduledCancel"`: Canceled due to exceeding scheduled cancel deadline (dead man\'s switch).',
+            ),
+          ),
+          /** Timestamp when the status was last updated (in ms since epoch). */
+          statusTimestamp: v.pipe(
+            UnsignedInteger,
+            v.description("Timestamp when the status was last updated (in ms since epoch)."),
+          ),
+        }),
+        v.description("Frontend order with current processing status."),
+      ),
+    ),
+    v.description("Array of frontend orders with current processing status."),
+  );
+})();
+export type HistoricalOrdersResponse = v.InferOutput<typeof HistoricalOrdersResponse>;
+
+// -------------------- Function --------------------
+
+/** Request parameters for the {@linkcode historicalOrders} function. */
+export type HistoricalOrdersParameters = Omit<v.InferInput<typeof HistoricalOrdersRequest>, "type">;
+
+/**
+ * Request user historical orders.
+ * @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 frontend orders with current processing status.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-historical-orders
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { historicalOrders } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await historicalOrders(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function historicalOrders(
+  config: InfoRequestConfig,
+  params: DeepImmutable<HistoricalOrdersParameters>,
+  signal?: AbortSignal,
+): Promise<HistoricalOrdersResponse> {
+  const request = parser(HistoricalOrdersRequest)({
+    type: "historicalOrders",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/src/api/info/isVip.ts

@@ -0,0 +1,79 @@
+import * as v from "valibot";
+import { Address, type DeepImmutable, parser } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request to check if a user is a VIP.
+ * @see null
+ */
+export const IsVipRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("isVip"),
+        v.description("Type of request."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+    }),
+    v.description("Request to check if a user is a VIP."),
+  );
+})();
+export type IsVipRequest = v.InferOutput<typeof IsVipRequest>;
+
+/**
+ * Boolean indicating user's VIP status.
+ * @see null
+ */
+export const IsVipResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.nullable(v.boolean()),
+    v.description("Boolean indicating user's VIP status."),
+  );
+})();
+export type IsVipResponse = v.InferOutput<typeof IsVipResponse>;
+
+// -------------------- Function --------------------
+
+/** Request parameters for the {@linkcode isVip} function. */
+export type IsVipParameters = Omit<v.InferInput<typeof IsVipRequest>, "type">;
+
+/**
+ * Request to check if a user is a VIP.
+ * @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 Boolean indicating user's VIP status.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { isVip } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await isVip(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function isVip(
+  config: InfoRequestConfig,
+  params: DeepImmutable<IsVipParameters>,
+  signal?: AbortSignal,
+): Promise<IsVipResponse> {
+  const request = parser(IsVipRequest)({
+    type: "isVip",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/src/api/info/l2Book.ts

@@ -0,0 +1,140 @@
+import * as v from "valibot";
+import { type DeepImmutable, Integer, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request L2 order book.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
+ */
+export const L2BookRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("l2Book"),
+        v.description("Type of request."),
+      ),
+      /** Asset symbol (e.g., BTC). */
+      coin: v.pipe(
+        v.string(),
+        v.description("Asset symbol (e.g., BTC)."),
+      ),
+      /** Number of significant figures. */
+      nSigFigs: v.pipe(
+        v.nullish(
+          v.pipe(
+            Integer,
+            v.union([v.literal(2), v.literal(3), v.literal(4), v.literal(5)]),
+          ),
+        ),
+        v.description("Number of significant figures."),
+      ),
+      /** Mantissa for aggregation (if `nSigFigs` is 5). */
+      mantissa: v.pipe(
+        v.nullish(
+          v.pipe(
+            Integer,
+            v.union([v.literal(2), v.literal(5)]),
+          ),
+        ),
+        v.description("Mantissa for aggregation (if `nSigFigs` is 5)."),
+      ),
+    }),
+    v.description("Request L2 order book."),
+  );
+})();
+export type L2BookRequest = v.InferOutput<typeof L2BookRequest>;
+
+/** L2 order book level. */
+const L2BookLevel = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Price. */
+      px: v.pipe(
+        UnsignedDecimal,
+        v.description("Price."),
+      ),
+      /** Total size. */
+      sz: v.pipe(
+        UnsignedDecimal,
+        v.description("Total size."),
+      ),
+      /** Number of individual orders. */
+      n: v.pipe(
+        UnsignedInteger,
+        v.description("Number of individual orders."),
+      ),
+    }),
+    v.description("L2 order book level."),
+  );
+})();
+type L2BookLevel = v.InferOutput<typeof L2BookLevel>;
+
+/**
+ * L2 order book snapshot.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
+ */
+export const L2BookResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Asset symbol. */
+      coin: v.pipe(
+        v.string(),
+        v.description("Asset symbol."),
+      ),
+      /** Timestamp of the snapshot (in ms since epoch). */
+      time: v.pipe(
+        UnsignedInteger,
+        v.description("Timestamp of the snapshot (in ms since epoch)."),
+      ),
+      /** Bid and ask levels (index 0 = bids, index 1 = asks). */
+      levels: v.pipe(
+        v.tuple([v.array(L2BookLevel), v.array(L2BookLevel)]),
+        v.description("Bid and ask levels (index 0 = bids, index 1 = asks)."),
+      ),
+    }),
+    v.description("L2 order book snapshot."),
+  );
+})();
+export type L2BookResponse = v.InferOutput<typeof L2BookResponse>;
+
+// -------------------- Function --------------------
+
+/** Request parameters for the {@linkcode l2Book} function. */
+export type L2BookParameters = Omit<v.InferInput<typeof L2BookRequest>, "type">;
+
+/**
+ * Request L2 order book.
+ * @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 L2 order book snapshot.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { l2Book } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await l2Book(
+ *   { transport },
+ *   { coin: "ETH", nSigFigs: 2 },
+ * );
+ * ```
+ */
+export function l2Book(
+  config: InfoRequestConfig,
+  params: DeepImmutable<L2BookParameters>,
+  signal?: AbortSignal,
+): Promise<L2BookResponse> {
+  const request = parser(L2BookRequest)({
+    type: "l2Book",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/src/api/info/leadingVaults.ts

@@ -0,0 +1,96 @@
+import * as v from "valibot";
+import { Address, type DeepImmutable, parser } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request leading vaults for a user.
+ * @see null
+ */
+export const LeadingVaultsRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("leadingVaults"),
+        v.description("Type of request."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+    }),
+    v.description("Request leading vaults for a user."),
+  );
+})();
+export type LeadingVaultsRequest = v.InferOutput<typeof LeadingVaultsRequest>;
+
+/**
+ * Array of leading vaults for a user.
+ * @see null
+ */
+export const LeadingVaultsResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.array(
+      /** Vault that a user is leading. */
+      v.pipe(
+        v.object({
+          /** Vault address. */
+          address: v.pipe(
+            Address,
+            v.description("Vault address."),
+          ),
+          /** Vault name. */
+          name: v.pipe(
+            v.string(),
+            v.description("Vault name."),
+          ),
+        }),
+        v.description("Vault that a user is leading."),
+      ),
+    ),
+    v.description("Array of leading vaults for a user."),
+  );
+})();
+export type LeadingVaultsResponse = v.InferOutput<typeof LeadingVaultsResponse>;
+
+// -------------------- Function --------------------
+
+/** Request parameters for the {@linkcode leadingVaults} function. */
+export type LeadingVaultsParameters = Omit<v.InferInput<typeof LeadingVaultsRequest>, "type">;
+
+/**
+ * Request leading vaults for a user.
+ * @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 leading vaults for a user.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { leadingVaults } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await leadingVaults(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function leadingVaults(
+  config: InfoRequestConfig,
+  params: DeepImmutable<LeadingVaultsParameters>,
+  signal?: AbortSignal,
+): Promise<LeadingVaultsResponse> {
+  const request = parser(LeadingVaultsRequest)({
+    type: "leadingVaults",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/src/api/info/legalCheck.ts

@@ -0,0 +1,95 @@
+import * as v from "valibot";
+import { Address, type DeepImmutable, parser } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request legal verification status of a user.
+ * @see null
+ */
+export const LegalCheckRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("legalCheck"),
+        v.description("Type of request."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+    }),
+    v.description("Request legal verification status of a user."),
+  );
+})();
+export type LegalCheckRequest = v.InferOutput<typeof LegalCheckRequest>;
+
+/**
+ * Legal verification status for a user.
+ * @see null
+ */
+export const LegalCheckResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Whether the user IP address is allowed. */
+      ipAllowed: v.pipe(
+        v.boolean(),
+        v.description("Whether the user IP address is allowed."),
+      ),
+      /** Whether the user has accepted the terms of service. */
+      acceptedTerms: v.pipe(
+        v.boolean(),
+        v.description("Whether the user has accepted the terms of service."),
+      ),
+      /** Whether the user is allowed to use the platform. */
+      userAllowed: v.pipe(
+        v.boolean(),
+        v.description("Whether the user is allowed to use the platform."),
+      ),
+    }),
+    v.description("Legal verification status for a user."),
+  );
+})();
+export type LegalCheckResponse = v.InferOutput<typeof LegalCheckResponse>;
+
+// -------------------- Function --------------------
+
+/** Request parameters for the {@linkcode legalCheck} function. */
+export type LegalCheckParameters = Omit<v.InferInput<typeof LegalCheckRequest>, "type">;
+
+/**
+ * Request legal verification status of a user.
+ * @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 Legal verification status for a user.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { legalCheck } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await legalCheck(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function legalCheck(
+  config: InfoRequestConfig,
+  params: DeepImmutable<LegalCheckParameters>,
+  signal?: AbortSignal,
+): Promise<LegalCheckResponse> {
+  const request = parser(LegalCheckRequest)({
+    type: "legalCheck",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}