Installation

Install the SDK via your package manager or a <script> tag.

Package Manager

npm

npm i @nktkas/hyperliquid

pnpm

yarn

bun

deno

CDN

If you're not using a package manager, you can use the SDK via an ESM-compatible CDN such as esm.sh. Simply add a <script type="module"> tag to the bottom of your HTML file with the following content:

<script type="module">
  import * as hl from "https://esm.sh/jsr/@nktkas/hyperliquid";
</script>

Platform Requirements

Node.js: requires v20 or higher.

Node.js 22+ includes native WebSocket support. For earlier versions, install the ws package if you plan to use WebSocketTransport:

npm install ws

import WebSocket from "ws";
import * as hl from "@nktkas/hyperliquid";

const transport = new hl.WebSocketTransport({
  reconnect: {
    WebSocket, // Pass WebSocket class from ws package
  },
});

React Native: requires polyfills for [`TextEncoder`](https://developer.mozilla.org/en-US/docs/Web/API/TextEncoder) and [`EventTarget`](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget). Install and import them before the SDK:

npm install fast-text-encoding event-target-polyfill

import "fast-text-encoding";
import "event-target-polyfill";
import * as hl from "@nktkas/hyperliquid";