@nktkas/hyperliquid/esm/api/info/_methods/vaultSummaries.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/vaultSummaries.ts" />
import * as v from "valibot";
import type { VaultRelationship } from "./_base/mod.js";
/**
 * Request a list of vaults less than 2 hours old.
 * @see null
 */
export declare const VaultSummariesRequest: v.ObjectSchema<{
    /** Type of request. */
    readonly type: v.LiteralSchema<"vaultSummaries", undefined>;
}, undefined>;
export type VaultSummariesRequest = v.InferOutput<typeof VaultSummariesRequest>;
/**
 * Array of vaults less than 2 hours old.
 * @see null
 */
export type VaultSummariesResponse = {
    /** Vault name. */
    name: string;
    /**
     * Vault address.
     * @pattern ^0x[a-fA-F0-9]{40}$
     */
    vaultAddress: `0x${string}`;
    /**
     * Leader address.
     * @pattern ^0x[a-fA-F0-9]{40}$
     */
    leader: `0x${string}`;
    /**
     * Total value locked.
     * @pattern ^[0-9]+(\.[0-9]+)?$
     */
    tvl: string;
    /** Vault closure status. */
    isClosed: boolean;
    /** Vault relationship type. */
    relationship: VaultRelationship;
    /** Creation timestamp (in ms since epoch). */
    createTimeMillis: number;
}[];
import type { InfoConfig } from "./_base/mod.js";
/**
 * Request a list of vaults less than 2 hours old.
 *
 * @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 Array of vaults less than 2 hours old.
 *
 * @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 { vaultSummaries } from "@nktkas/hyperliquid/api/info";
 *
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * const data = await vaultSummaries({ transport });
 * ```
 *
 * @see null
 */
export declare function vaultSummaries(config: InfoConfig, signal?: AbortSignal): Promise<VaultSummariesResponse>;