@nktkas/hyperliquid/esm/api/info/_methods/perpDexLimits.d.ts

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

/// <amd-module name="file:///home/runner/work/hyperliquid/hyperliquid/src/api/info/_methods/perpDexLimits.ts" />
import * as v from "valibot";
/**
 * 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.ObjectSchema<{
    /** Type of request. */
    readonly type: v.LiteralSchema<"perpDexLimits", undefined>;
    /** DEX name (empty string for main dex). */
    readonly dex: v.StringSchema<undefined>;
}, undefined>;
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 type PerpDexLimitsResponse = {
    /**
     * Total open interest cap.
     * @pattern ^[0-9]+(\.[0-9]+)?$
     */
    totalOiCap: string;
    /**
     * Open interest size cap per perpetual.
     * @pattern ^[0-9]+(\.[0-9]+)?$
     */
    oiSzCapPerPerp: string;
    /**
     * Maximum transfer notional amount.
     * @pattern ^[0-9]+(\.[0-9]+)?$
     */
    maxTransferNtl: string;
    /** Coin to open interest cap mapping. */
    coinToOiCap: [
        /** Asset symbol (e.g., xyz:AAPL). */
        coin: string,
        /**
         * Open interest cap.
         * @pattern ^[0-9]+(\.[0-9]+)?$
         */
        oiCap: string
    ][];
} | null;
import type { InfoConfig } from "./_base/mod.js";
/** 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 {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
 * @return Builder deployed perpetual market limits.
 *
 * @throws {ValidationError} 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 declare function perpDexLimits(config: InfoConfig, params: PerpDexLimitsParameters, signal?: AbortSignal): Promise<PerpDexLimitsResponse>;