Hyperliquid JavaScript SDK example: ws-private.ts
Hyperliquid websocket private JavaScript example for the Siebly Hyperliquid SDK, covering exchange REST API and WebSocket integration, setup, and production SDK docs.
We use environment variables in our examples for API keys. It is your responsibility to manage and secure your keys appropriately.
examples/Hyperliquid/Websocket/ws-private.ts
What this example covers
- Hyperliquid WebSocket stream JavaScript example.
- Uses the Siebly Hyperliquid SDK package
@siebly/hyperliquid-apiinstead of hand-written WebSocket plumbing. - Source path:
Hyperliquid/Websocket/ws-private.ts. - Imports SDK symbols including
DefaultLogger,WebsocketClient. - Calls SDK methods such as
on(),subscribe(),closeAll().
How to use this example
- Start here for the specific request or stream pattern, then check the matching SDK guide for install, credentials, and operational notes.
- For WebSocket examples, keep reconnect, resubscribe, heartbeat, and event-handler behavior explicit in your service.
- Open the repository source when you need the latest committed version: GitHub source file.
import { DefaultLogger, WebsocketClient } from '@siebly/hyperliquid-api'; // or// import { DefaultLogger, WebsocketClient } from '@siebly/hyperliquid-api'; /** * Account streams. These need a wallet address, not a private key. The SDK * isolates user streams whose server events omit the user onto per-user * connections. * * Data emits through on('message'), with the original channel and wsKey. * Subscription acknowledgements emit through on('response'). * * Unix: * HYPERLIQUID_ADDRESS='0xabc' npx tsx examples/Websocket/ws-private.ts */const user = process.env.HYPERLIQUID_ADDRESS || '0x4529cB8C5A97D33ceD674970218DCC2312ef689C';if (!user) { throw new Error( "Missing HYPERLIQUID_ADDRESS. Unix example: HYPERLIQUID_ADDRESS='0xabc' npx tsx examples/Websocket/ws-private.ts", );} const logger = { ...DefaultLogger, // trace: (...params: unknown[]) => console.log(new Date(), 'trace', ...params),}; const wsClient = new WebsocketClient( { // testnet: true, }, logger,); wsClient.on('open', (data) => { console.log('ws connection opened:', data.wsKey);}); wsClient.on('reconnecting', ({ wsKey }) => { console.log('ws automatically reconnecting.... ', wsKey);}); wsClient.on('reconnected', (data) => { console.log('ws has reconnected ', data?.wsKey);}); wsClient.on('exception', ({ event, data, wsKey }) => { console.error('ws exception:', wsKey, event ?? data);}); wsClient.on('response', (event) => { console.log('ws response:', event.wsKey, event.channel, event.data);}); wsClient.on('message', (event) => { switch (event.channel) { case 'orderUpdates': console.log('Orders:', event.wsKey, event.data); break; case 'userFills': console.log( 'Fills:', event.data.user, event.data.isSnapshot, event.data.fills, ); break; default: console.log('Account update:', event.wsKey, event.channel, event.data); }}); async function main() { if (!user) return; try { await wsClient.subscribe([ { type: 'userEvents', user }, { type: 'userFills', user }, { type: 'orderUpdates', user }, { type: 'openOrders', user }, { type: 'activeAssetData', user, coin: 'BTC' }, { type: 'clearinghouseState', user }, { type: 'notification', user }, ]); } catch (error) { console.error('subscribe failed:', error); wsClient.closeAll(); }} process.once('SIGINT', () => wsClient.closeAll());void main();