Quick Start

Get started with the SDK in just a few lines of code.

Set up Transport

First, create a Transport - the layer that handles communication with Hyperliquid servers.

Use HttpTransport for simple requests.

import { HttpTransport } from "@nktkas/hyperliquid";

const transport = new HttpTransport();

Create a Client

Next, create a Client with your transport. The SDK provides three clients for different purposes:

Use Info to query market data, account state, and other read-only information.

import { HttpTransport, InfoClient } from "@nktkas/hyperliquid";

const transport = new HttpTransport();
const info = new InfoClient({ transport });

Use ExchangeClient to place orders, transfer funds, and perform other actions that require signing.

import { ExchangeClient, HttpTransport } from "@nktkas/hyperliquid";
import { privateKeyToAccount } from "viem/accounts";

const wallet = privateKeyToAccount("0x..."); // viem account or ethers signer

const transport = new HttpTransport();
const exchange = new ExchangeClient({ transport, wallet });

Use SubscriptionClient to subscribe to live market data via WebSocket.

import { SubscriptionClient, WebSocketTransport } from "@nktkas/hyperliquid";

const transport = new WebSocketTransport();
const subs = new SubscriptionClient({ transport });

Use the Client

Call client methods to query data, place orders, or subscribe to streams.

// Retrieve mids for all coins
const mids = await info.allMids();

// Retrieve a user's open orders
const openOrders = await info.openOrders({ user: "0x..." });

// L2 book snapshot
const book = await info.l2Book({ coin: "BTC" });

// Place an order
const result = await exchange.order({
  orders: [{
    a: 0,
    b: true,
    p: "95000",
    s: "0.01",
    r: false,
    t: { limit: { tif: "Gtc" } },
  }],
  grouping: "na",
});

// Update leverage
await exchange.updateLeverage({ asset: 0, isCross: true, leverage: 5 });

// Initiate a withdrawal request
await exchange.withdraw3({ destination: "0x...", amount: "1" });

// Subscribe to mids for all coins
await subs.allMids((data) => {
  console.log(data);
});

// Subscribe to user's open orders
await subs.openOrders({ user: "0x..." }, (data) => {
  console.log(data);
});

// Subscribe to L2 book snapshot
await subs.l2Book({ coin: "ETH" }, (data) => {
  console.log(data);
});

PreviousInstallation NextTransports

Last updated 4 days ago

hashtagSet up Transport

hashtagCreate a Client

hashtagUse the Client

Set up Transport

Create a Client

Use the Client