Hyperliquid JavaScript SDK example: rest-leverage.ts
Hyperliquid REST leverage 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/Rest/rest-leverage.ts
What this example covers
- Hyperliquid REST API JavaScript example.
- Uses the Siebly Hyperliquid SDK package
@siebly/hyperliquid-apiinstead of hand-written HTTP request plumbing. - Source path:
Hyperliquid/Rest/rest-leverage.ts. - Imports SDK symbols including
RestClient. - Calls SDK methods such as
getPerpAccountSummary(),updateLeverage(),updateIsolatedMargin().
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.
- Open the repository source when you need the latest committed version: GitHub source file.
import { RestClient } from '@siebly/hyperliquid-api'; // or// import { RestClient } from '@siebly/hyperliquid-api'; /** * Read ETH leverage, then set cross and isolated leverage. * * Unix: * HYPERLIQUID_PRIVATE_KEY='0xabc' npx tsx examples/Rest/rest-leverage.ts */const privateKey = process.env.HYPERLIQUID_PRIVATE_KEY;if (!privateKey) { throw new Error( "Missing HYPERLIQUID_PRIVATE_KEY. Unix example: HYPERLIQUID_PRIVATE_KEY='0xabc' npx tsx examples/Rest/rest-leverage.ts", );} const client = new RestClient({ privateKey, // testnet: true,}); async function main() { try { const summary = await client.getPerpAccountSummary(); for (const entry of summary.assetPositions) { if (entry.position.coin === 'ETH') { console.log('ETH leverage:', entry.position.leverage); } } console.log( 'cross 21x:', await client.updateLeverage({ asset: 'ETH', isCross: true, leverage: 21, }), ); console.log( 'isolated 21x:', await client.updateLeverage({ asset: 'ETH', isCross: false, leverage: 21, }), ); try { console.log( 'isolated margin top-up:', await client.updateIsolatedMargin({ asset: 'ETH', isBuy: true, ntli: 1, }), ); } catch (e) { console.log( 'isolated margin top-up skipped (needs an ETH position):', e instanceof Error ? e.message : e, ); } } catch (e) { console.error('request failed: ', e); }} main();