Hyperliquid JavaScript SDK example: rest-spot-order.ts
Hyperliquid REST spot order 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-spot-order.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-spot-order.ts. - Imports SDK symbols including
RestClient. - Calls SDK methods such as
getSpotBalances(),submitLimitOrder(),getOrderStatus(),cancelOrders().
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 { type ExchangeResponse, type OrderResponseData, RestClient,} from '@siebly/hyperliquid-api'; // or// import { RestClient } from '@siebly/hyperliquid-api'; /** * Spot limit order on PURR/USDC. Spot size is always the base asset quantity. * Hyperliquid requires a minimum order value of 10 USDC. * * Unix: * HYPERLIQUID_PRIVATE_KEY='0xabc' npx tsx examples/Rest/rest-spot-order.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-spot-order.ts", );} const client = new RestClient({ privateKey, // testnet: true,}); function firstRestingOid( result: ExchangeResponse<OrderResponseData>,): number | undefined { if (result.status !== 'ok') { return undefined; } const status = result.response.data?.statuses[0]; return status && 'resting' in status ? status.resting.oid : undefined;} async function main() { try { const balances = await client.getSpotBalances(); console.log('spot balances:', balances.balances); const purr = await client.submitLimitOrder({ price: '0.01', side: 'buy', size: '1100', symbol: 'PURR/USDC', }); console.log('PURR/USDC order:', JSON.stringify(purr, null, 2)); const oid = firstRestingOid(purr); if (oid === undefined) { console.log('order did not rest; nothing to cancel'); return; } console.log('status:', await client.getOrderStatus({ oid })); console.log( 'cancel:', await client.cancelOrders({ cancels: [{ a: 'PURR/USDC', o: oid }], }), ); // Numeric spot IDs also work. @107 is the HYPE/USDC alias on mainnet; // testnet IDs differ. Prefer the pair name. // const other = await client.submitLimitOrder({ // price: '12', // side: 'buy', // size: '1', // symbol: '@8', // }); } catch (e) { console.error('request failed: ', e); }} main();