UNPKG

@nktkas/hyperliquid

Version:

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

42 lines (41 loc) 1.71 kB
import * as v from "valibot"; /** * 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 const AllPerpMetasRequest = /* @__PURE__ */ (()=>{ return v.object({ /** Type of request. */ type: v.literal("allPerpMetas") }); })(); // ============================================================ // Execution Logic // ============================================================ import { parse } from "../../../_base.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 function allPerpMetas(config, signal) { const request = parse(AllPerpMetasRequest, { type: "allPerpMetas" }); return config.transport.request("info", request, signal); } //# sourceMappingURL=allPerpMetas.js.map