Architecture
Advanced Features
Strategy Engine
Unified REST API
Unified WebSocket API
Management API
Help
{
"jsonrpc": "2.0",
"id": 1,
"method": "subscribe",
"params": [
"order_book",
{
"symbols": [
"BTC"
]
}
]
}{
"jsonrpc": "2.0",
"id": 1,
"method": "subscribe",
"params": [
"trades",
{
"symbols": [
"BTC"
]
}
]
}{
"jsonrpc": "2.0",
"id": 1,
"method": "subscribe",
"params": [
"ticker",
{
"symbols": [
"BTC"
]
}
]
}{
"jsonrpc": "2.0",
"id": 1,
"method": "subscribe",
"params": [
"orders",
{
"address": "0xAccc...",
"symbols": [
"BTC",
"ETH"
]
}
]
}{
"jsonrpc": "2.0",
"id": 1,
"method": "subscribe",
"params": [
"balance",
{
"address": "0xAccc...",
"assets": [
"USDC"
]
}
]
}{
"jsonrpc": "2.0",
"id": 1,
"method": "subscribe",
"params": [
"position",
{
"address": "0xAccc...",
"symbols": [
"BTC"
]
}
]
}{
"jsonrpc": "2.0",
"id": 7,
"method": "subscribe",
"params": [
"user_fills",
{
"symbols": [
"BTC",
"ETH"
]
}
]
}{
"jsonrpc": "2.0",
"id": 7,
"method": "subscribe",
"params": [
"user_funding_fee",
{
"address": "0xAccc..."
}
]
}{
"jsonrpc": "2.0",
"id": 8,
"method": "subscribe",
"params": [
"liquidation_trades",
{
"scope": "user",
"address": "0x1234567890abcdef1234567890abcdef12345678"
}
]
}{
"jsonrpc": "2.0",
"id": 2,
"method": "unsubscribe",
"params": [
"0x1a2b3c4d5e6f..."
]
}{
"jsonrpc": "2.0",
"id": 1,
"result": "0x1a2b3c4d5e6f..."
}{
"jsonrpc": "2.0",
"id": 2,
"result": true
}Subscription
Channel for sending subscription and unsubscription requests (available on hyperliquid, aster, lighter, and kuru servers). Note - position, user_funding_fee, and liquidation_trades are not available on kuru (spot DEX).
{
"jsonrpc": "2.0",
"id": 1,
"method": "subscribe",
"params": [
"order_book",
{
"symbols": [
"BTC"
]
}
]
}{
"jsonrpc": "2.0",
"id": 1,
"method": "subscribe",
"params": [
"trades",
{
"symbols": [
"BTC"
]
}
]
}{
"jsonrpc": "2.0",
"id": 1,
"method": "subscribe",
"params": [
"ticker",
{
"symbols": [
"BTC"
]
}
]
}{
"jsonrpc": "2.0",
"id": 1,
"method": "subscribe",
"params": [
"orders",
{
"address": "0xAccc...",
"symbols": [
"BTC",
"ETH"
]
}
]
}{
"jsonrpc": "2.0",
"id": 1,
"method": "subscribe",
"params": [
"balance",
{
"address": "0xAccc...",
"assets": [
"USDC"
]
}
]
}{
"jsonrpc": "2.0",
"id": 1,
"method": "subscribe",
"params": [
"position",
{
"address": "0xAccc...",
"symbols": [
"BTC"
]
}
]
}{
"jsonrpc": "2.0",
"id": 7,
"method": "subscribe",
"params": [
"user_fills",
{
"symbols": [
"BTC",
"ETH"
]
}
]
}{
"jsonrpc": "2.0",
"id": 7,
"method": "subscribe",
"params": [
"user_funding_fee",
{
"address": "0xAccc..."
}
]
}{
"jsonrpc": "2.0",
"id": 8,
"method": "subscribe",
"params": [
"liquidation_trades",
{
"scope": "user",
"address": "0x1234567890abcdef1234567890abcdef12345678"
}
]
}{
"jsonrpc": "2.0",
"id": 2,
"method": "unsubscribe",
"params": [
"0x1a2b3c4d5e6f..."
]
}{
"jsonrpc": "2.0",
"id": 1,
"result": "0x1a2b3c4d5e6f..."
}{
"jsonrpc": "2.0",
"id": 2,
"result": true
}API key for authentication (required for private channels)
Subscribe to order book updates
Subscribe to trade executions
Subscribe to price ticker updates
Subscribe to order status changes (requires authentication).
Multi-account support (Kuru only): Use accountId to subscribe to a specific account's orders.
If not specified, defaults to the primary account.
Subscribe to balance changes (requires authentication).
Multi-account support (Kuru only): Use accountId to subscribe to a specific account's balance.
If not specified, defaults to the primary account.
Subscribe to position changes (requires authentication)
Subscribe to user trade fills/executions (requires authentication).
Multi-account support (Kuru only): Use accountId to subscribe to a specific account's fills.
If not specified, defaults to the primary account.
Subscribe to user funding fee settlements (requires authentication)
Subscribe to liquidation executions (symbol-scoped or user-scoped)
Unsubscribe from a channel
Response after subscribing to a channel
Response after unsubscribing from a channel