@nktkas/hyperliquid/esm/api/info/_methods/maxMarketOrderNtls.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/maxMarketOrderNtls.ts" />
import * as v from "valibot";
/**
 * Request maximum market order notionals.
 * @see null
 */
export declare const MaxMarketOrderNtlsRequest: v.ObjectSchema<{
    /** Type of request. */
    readonly type: v.LiteralSchema<"maxMarketOrderNtls", undefined>;
}, undefined>;
export type MaxMarketOrderNtlsRequest = v.InferOutput<typeof MaxMarketOrderNtlsRequest>;
/**
 * Array of tuples of maximum leverage and its corresponding maximum market order notional.
 * @see null
 */
export type MaxMarketOrderNtlsResponse = [
    /** Maximum leverage. */
    maxLeverage: number,
    /**
     * Maximum market order notional.
     * @pattern ^[0-9]+(\.[0-9]+)?$
     */
    maxMarketOrderNtl: string
][];
import type { InfoConfig } from "./_base/mod.js";
/**
 * Request maximum market order notionals.
 *
 * @param config General configuration for Info API requests.
 * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
 * @return Maximum market order notionals.
 *
 * @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 { maxMarketOrderNtls } from "@nktkas/hyperliquid/api/info";
 *
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * const data = await maxMarketOrderNtls({ transport });
 * ```
 *
 * @see null
 */
export declare function maxMarketOrderNtls(config: InfoConfig, signal?: AbortSignal): Promise<MaxMarketOrderNtlsResponse>;