@nktkas/hyperliquid/esm/api/info/_methods/allPerpMetas.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/allPerpMetas.ts" />
import * as v from "valibot";
import type { MetaResponse } from "./meta.js";
/**
 * Request trading metadata for all DEXs.
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetuals-metadata-universe-and-margin-tables
 */
export declare const AllPerpMetasRequest: v.ObjectSchema<{
    /** Type of request. */
    readonly type: v.LiteralSchema<"allPerpMetas", undefined>;
}, undefined>;
export type AllPerpMetasRequest = v.InferOutput<typeof AllPerpMetasRequest>;
/**
 * Metadata for perpetual assets across all DEXs.
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetuals-metadata-universe-and-margin-tables
 */
export type AllPerpMetasResponse = MetaResponse[];
import type { InfoConfig } from "./_base/mod.js";
/**
 * Request trading metadata for all DEXs.
 *
 * @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 Metadata for perpetual assets across all DEXs.
 *
 * @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 { allPerpMetas } from "@nktkas/hyperliquid/api/info";
 *
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * const data = await allPerpMetas({ transport });
 * ```
 *
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetuals-metadata-universe-and-margin-tables
 */
export declare function allPerpMetas(config: InfoConfig, signal?: AbortSignal): Promise<AllPerpMetasResponse>;