TypeScript SDK
Connect to Aleatoric Hyperliquid feeds from TypeScript/Node.js. Fully typed, async iterators, automatic reconnection.
Install typescript
npm install @aleatoric/sdkQuickstart
1. Install
npm install @aleatoric/sdk2. Connect
import { Aleatoric } from '@aleatoric/sdk'
const client = new Aleatoric('ak_your_key')3. Stream Data
for await (const event of client.stream('BTC')) {
console.log(`Mid: ${event.mid} | Spread: ${event.spread}`)
console.log(`Best bid: ${event.bestBid} x ${event.bidQty}`)
}Workflows
Connect to Endpoint
import { Aleatoric } from '@aleatoric/sdk'
// US region (default)
const client = new Aleatoric('ak_your_key')
// Japan region
const clientJp = new Aleatoric('ak_your_key', { region: 'jp' })Subscribe to Fills
for await (const fill of client.fills('ETH')) {
console.log(`Fill: ${fill.side} ${fill.size} @ ${fill.price}`)
console.log(`Fee: ${fill.feeUsd}`)
}Handle Liquidation Events
for await (const liq of client.liquidations('BTC', { minSizeUsd: 50000 })) {
console.log(`LIQUIDATION: ${liq.side} $${liq.sizeUsd.toLocaleString()}`)
console.log(`Severity: ${liq.severity}`)
if (liq.cascadeRisk) {
console.log('WARNING: Cascade risk detected')
}
}