@nktkas/hyperliquid/script/src/api/info/_methods/maxMarketOrderNtls.d.ts

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

import * as v from "valibot";
/**
 * Request maximum market order notionals.
 */
export declare const MaxMarketOrderNtlsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
    /** Type of request. */
    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"maxMarketOrderNtls", undefined>, v.DescriptionAction<"maxMarketOrderNtls", "Type of request.">]>;
}, undefined>, v.DescriptionAction<{
    type: "maxMarketOrderNtls";
}, "Request maximum market order notionals.">]>;
export type MaxMarketOrderNtlsRequest = v.InferOutput<typeof MaxMarketOrderNtlsRequest>;
/**
 * Maximum market order notionals.
 */
export declare const MaxMarketOrderNtlsResponse: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.TupleSchema<[v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.StringSchema<undefined>], undefined>, v.DescriptionAction<[string, string], "Tuple of maximum market order notional and corresponding asset symbol.">]>, undefined>, v.DescriptionAction<[string, string][], "Maximum market order notionals.">]>;
export type MaxMarketOrderNtlsResponse = v.InferOutput<typeof MaxMarketOrderNtlsResponse>;
import type { InfoConfig } from "./_types.js";
/**
 * Request maximum market order notionals.
 *
 * @param config - General configuration for Info API requests.
 * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
 *
 * @returns Maximum market order notionals.
 *
 * @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 { maxMarketOrderNtls } from "@nktkas/hyperliquid/api/info";
 *
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * const data = await maxMarketOrderNtls({ transport });
 * ```
 */
export declare function maxMarketOrderNtls(config: InfoConfig, signal?: AbortSignal): Promise<MaxMarketOrderNtlsResponse>;
//# sourceMappingURL=maxMarketOrderNtls.d.ts.map