@nktkas/hyperliquid/esm/src/api/info/_methods/perpDexLimits.js

Hyperliquid API SDK for all major JS runtimes, written in TypeScript.

import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { UnsignedDecimal } from "../../_schemas.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 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 - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
 *
 * @returns Builder deployed perpetual market limits.
 *
 * @throws {ValiError} When the request parameters fail validation (before sending).
 * @throws {TransportError} When the transport layer throws an error.
 *
 * @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" },
 * );
 * ```
 *
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
 */
export function perpDexLimits(config, params, signal) {
    const request = v.parse(PerpDexLimitsRequest, {
        type: "perpDexLimits",
        ...params,
    });
    return config.transport.request("info", request, signal);
}
//# sourceMappingURL=perpDexLimits.js.map