Architecture
Advanced Features
Unified REST API
Unified WebSocket API
Management API
Help
Messages
{
"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
}Websockets
Subscription
Channel for sending subscription and unsubscription requests (available on hyperliquid, aster, and lighter servers only)
WSS
Messages
{
"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
}apiKey
type:httpApiKey
API key for authentication (required for private channels)
Subscribe to Order Book
type:object
Subscribe to order book updates
Subscribe to Trades
type:object
Subscribe to trade executions
Subscribe to Ticker
type:object
Subscribe to price ticker updates
Subscribe to Orders
type:object
Subscribe to order status changes (requires authentication)
Subscribe to Balance
type:object
Subscribe to balance changes (requires authentication)
Subscribe to Position
type:object
Subscribe to position changes (requires authentication)
Subscribe to User Fills
type:object
Subscribe to user trade fills/executions (requires authentication)
Subscribe to User Funding Fee
type:object
Subscribe to user funding fee settlements (requires authentication)
Subscribe to Liquidation Trades
type:object
Subscribe to liquidation executions (symbol-scoped or user-scoped)
Unsubscribe
type:object
Unsubscribe from a channel
Subscription Response
type:object
Response after subscribing to a channel
Unsubscribe Response
type:object
Response after unsubscribing from a channel
⌘I