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

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

import * as v from "valibot";
/**
 * Request margin table data.
 */
export declare const MarginTableRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
    /** Type of request. */
    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"marginTable", undefined>, v.DescriptionAction<"marginTable", "Type of request.">]>;
    /** Margin requirements table. */
    readonly id: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Margin requirements table.">]>;
}, undefined>, v.DescriptionAction<{
    type: "marginTable";
    id: number;
}, "Request margin table data.">]>;
export type MarginTableRequest = v.InferOutput<typeof MarginTableRequest>;
/**
 * Margin requirements table with multiple tiers.
 */
export declare const MarginTableResponse: v.SchemaWithPipe<readonly [v.ObjectSchema<{
    /** Description of the margin table. */
    readonly description: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Description of the margin table.">]>;
    /** Array of margin tiers defining leverage limits. */
    readonly marginTiers: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
        /** Lower position size boundary for this tier. */
        readonly lowerBound: v.SchemaWithPipe<readonly [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.DescriptionAction<string, "Lower position size boundary for this tier.">]>;
        /** Maximum allowed leverage for this tier. */
        readonly maxLeverage: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.MinValueAction<number, 1, undefined>, v.DescriptionAction<number, "Maximum allowed leverage for this tier.">]>;
    }, undefined>, v.DescriptionAction<{
        lowerBound: string;
        maxLeverage: number;
    }, "Individual tier in a margin requirements table.">]>, undefined>, v.DescriptionAction<{
        lowerBound: string;
        maxLeverage: number;
    }[], "Array of margin tiers defining leverage limits.">]>;
}, undefined>, v.DescriptionAction<{
    description: string;
    marginTiers: {
        lowerBound: string;
        maxLeverage: number;
    }[];
}, "Margin requirements table with multiple tiers.">]>;
export type MarginTableResponse = v.InferOutput<typeof MarginTableResponse>;
import type { InfoConfig } from "./_types.js";
/** Request parameters for the {@linkcode marginTable} function. */
export type MarginTableParameters = Omit<v.InferInput<typeof MarginTableRequest>, "type">;
/**
 * Request margin table data.
 *
 * @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 Margin requirements table with multiple tiers.
 *
 * @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 { marginTable } from "@nktkas/hyperliquid/api/info";
 *
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * const data = await marginTable(
 *   { transport },
 *   { id: 1 },
 * );
 * ```
 */
export declare function marginTable(config: InfoConfig, params: MarginTableParameters, signal?: AbortSignal): Promise<MarginTableResponse>;
//# sourceMappingURL=marginTable.d.ts.map