Hyperliquid JavaScript SDK example: rest-schedule-cancel.ts
Hyperliquid REST schedule cancel 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-schedule-cancel.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-schedule-cancel.ts. - Imports SDK symbols including
RestClient. - Calls SDK methods such as
submitLimitOrder(),getOrderStatus(),setCancelAllAfter(),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'; /** * Dead-man's switch: place a resting limit, then schedule cancel-all after 10s. * Hyperliquid only enables this after $1M traded volume; the example still * places and cancels the limit so the order path is exercised either way. * * Unix: * HYPERLIQUID_PRIVATE_KEY='0xabc' npx tsx examples/Rest/rest-schedule-cancel.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-schedule-cancel.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 result = await client.submitLimitOrder({ price: '1100', side: 'buy', size: '0.01', symbol: 'ETH', }); console.log('limit order:', JSON.stringify(result, null, 2)); const oid = firstRestingOid(result); if (oid !== undefined) { console.log('status:', await client.getOrderStatus({ oid })); } try { console.log( 'schedule cancel-all:', await client.setCancelAllAfter({ time: Date.now() + 10_000 }), ); } catch (e) { console.log( 'schedule cancel-all skipped:', e instanceof Error ? e.message : e, ); } if (oid !== undefined) { console.log( 'cancel resting order:', await client.cancelOrders({ cancels: [{ a: 'ETH', o: oid }], }), ); } } catch (e) { console.error('request failed: ', e); }} main();