@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
39 lines (38 loc) • 1.36 kB
TypeScript
/**
* Hyperliquid API TypeScript SDK.
*
* The main entrypoint exports:
* - Transports: {@link HttpTransport}, {@link WebSocketTransport}
* - Clients: {@link InfoClient}, {@link ExchangeClient}, {@link SubscriptionClient}, {@link ExplorerClient}
*
* For tree-shakeable, low-level access you can import request methods directly from:
* - `@nktkas/hyperliquid/api/info`
* - `@nktkas/hyperliquid/api/exchange`
* - `@nktkas/hyperliquid/api/subscription`
* - `@nktkas/hyperliquid/api/explorer`
*
* Extra utilities are available in:
* - `@nktkas/hyperliquid/utils` (formatting, symbol conversion)
* - `@nktkas/hyperliquid/signing` (low-level signing helpers)
*
* @example Quick start
* ```ts
* import { HttpTransport, InfoClient } from "@nktkas/hyperliquid";
*
* const transport = new HttpTransport();
* const info = new InfoClient({ transport });
*
* const mids = await info.allMids();
* console.log(mids);
* ```
*
* @module
*/
/// <amd-module name="file:///home/runner/work/hyperliquid/hyperliquid/src/mod.ts" />
export { HyperliquidError, ValidationError } from "./_base.js";
export { AbstractWalletError } from "./signing/mod.js";
export * from "./transport/mod.js";
export * from "./api/exchange/client.js";
export * from "./api/explorer/client.js";
export * from "./api/info/client.js";
export * from "./api/subscription/client.js";