WebSocket
This page will help you get started with zkLighter WebSocket server. You'll be up and running in a jiffy!
Connection
URL: wss://mainnet.zklighter.elliot.ai/stream
You can directly connect to the WebSocket server using wscat:
wscat -c 'wss://mainnet.zklighter.elliot.ai/stream'
Channels
Order Book
The order book channel sends the new ask and bid orders for the given market.
{
"type": "subscribe",
"channel": "order_book/{MARKET_INDEX}"
}
Example Subscription
{
"type": "subscribe",
"channel": "order_book/0"
}
Response Structure
{
"channel": "order_book:{MARKET_INDEX}",
"offset": INTEGER,
"order_book": {
"code": INTEGER,
"asks": [
{
"price": STRING,
"size": STRING
}
],
"bids": [
{
"price": STRING,
"size": STRING
}
],
"offset": INTEGER
},
"type": "update/order_book"
}
Example Response
{
"channel": "order_book:0",
"offset": 41692864,
"order_book": {
"code": 0,
"asks": [
{
"price": "3327.46",
"size": "29.0915"
}
],
"bids": [
{
"price": "3338.80",
"size": "10.2898"
}
],
"offset": 41692864
},
"type": "update/order_book"
}
Market Stats
The market stats channel sends the market stat data for the given market.
{
"type": "subscribe",
"channel": "market_stats/{MARKET_INDEX}"
}
or
{
"type": "subscribe",
"channel": "market_stats/all"
}
Example Subscription
{
"type": "subscribe",
"channel": "market_stats/0"
}
Response Structure
{
"channel": "market_stats:0",
"market_stats": {
"market_id": INTEGER,
"index_price": STRING,
"mark_price": STRING,
"last_trade_price": STRING,
"current_funding_rate": STRING,
"funding_rate": STRING,
"funding_timestamp": INTEGER,
"daily_base_token_volume": FLOAT,
"daily_quote_token_volume": FLOAT,
"daily_price_low": FLOAT,
"daily_price_high": FLOAT,
"daily_price_change": FLOAT
},
"type": "update/market_stats"
}
Example Response
{
"channel": "market_stats:0",
"market_stats": {
"market_id": 0,
"index_price": "3335.04",
"mark_price": "3335.09",
"last_trade_price": "3335.65",
"current_funding_rate": "0.0057",
"funding_rate": "0.0005",
"funding_timestamp": 1722337200000,
"daily_base_token_volume": 230206.48999999944,
"daily_quote_token_volume": 765295250.9804002,
"daily_price_low": 3265.13,
"daily_price_high": 3386.01,
"daily_price_change": -1.1562612047992835
},
"type": "update/market_stats"
}
Trade
The trade channel sends the new trade data for the given market.
{
"type": "subscribe",
"channel": "trade/{MARKET_INDEX}"
}
Example Subscription
{
"type": "subscribe",
"channel": "trade/0"
}
Response Structure
{
"channel": "trade:{MARKET_INDEX}",
"trades": [
{
"trade_id": INTEGER,
"tx_hash": STRING,
"type": STRING,
"market_id": INTEGER,
"size": STRING,
"price": STRING,
"usd_amount": STRING,
"ask_id": INTEGER,
"bid_id": INTEGER,
"ask_account_id": INTEGER,
"bid_account_id": INTEGER,
"is_maker_ask": BOOLEAN,
"block_height": INTEGER,
"timestamp": INTEGER
}
],
"type": "update/trade"
}
Example Response
{
"channel": "trade:0",
"trades": [
{
"trade_id": 14035051,
"tx_hash": "189068ebc6b5c7e5efda96f92842a2fafd280990692e56899a98de8c4a12a38c",
"type": "trade",
"market_id": 0,
"size": "0.1187",
"price": "3335.65",
"usd_amount": "13.67",
"ask_id": 41720126,
"bid_id": 41720037,
"ask_account_id": 2304,
"bid_account_id": 21504,
"is_maker_ask": false,
"block_height": 2204468,
"timestamp": 1722339648
}
],
"type": "update/trade"
}
Account All
The account all channel sends specific account market data for all markets.
{
"type": "subscribe",
"channel": "account_all/{ACCOUNT_ID}"
}
Example Subscription
{
"type": "subscribe",
"channel": "account_all/1"
}
Response Structure
{
"account": INTEGER,
"channel": "account_all:{ACCOUNT_ID}",
"funding_histories": {
"{MARKET_INDEX}": [
{
"timestamp": INTEGER,
"market_id": INTEGER,
"funding_id": INTEGER,
"change": STRING,
"rate": STRING,
"position_size": STRING,
"position_side": STRING
}
]
},
"liquidations": [
{
"liquidation_id": INTEGER,
"account_index": INTEGER,
"liquidation_type": INTEGER,
"portfolio_value": STRING,
"margin_requirement": STRING
}
],
"positions": {
"{MARKET_INDEX}": {
"market_id": INTEGER,
"symbol": STRING,
"initial_margin_fraction": STRING,
"open_order_count": INTEGER,
"pending_order_count": INTEGER,
"sign": INTEGER,
"position": STRING,
"avg_entry_price": STRING,
"position_value": STRING,
"unrealized_pnl": STRING,
"realized_pnl": STRING
}
},
"shares": [
{
"public_pool_index": INTEGER,
"shares_amount": INTEGER,
"entry_usdc": STRING
}
],
"trades": {
"{MARKET_INDEX}": [
{
"trade_id": INTEGER,
"tx_hash": STRING,
"type": STRING,
"market_id": INTEGER,
"size": STRING,
"price": STRING,
"usd_amount": STRING,
"ask_id": INTEGER,
"bid_id": INTEGER,
"ask_account_id": INTEGER,
"bid_account_id": INTEGER,
"is_maker_ask": BOOLEAN,
"block_height": INTEGER,
"timestamp": INTEGER
}
]
},
"type": "update/account"
}
Example Response
{
"account": 10,
"channel": "account_all:10",
"funding_histories": {
"1": [
{
"timestamp": 1700000000,
"market_id": 101,
"funding_id": 2001,
"change": "0.001",
"rate": "0.0001",
"position_size": "0.5",
"position_side": "long"
}
]
},
"liquidations": [
{
"liquidation_id": 301,
"account_index": 1,
"liquidation_type": 2,
"portfolio_value": "10000.00",
"margin_requirement": "8000.00"
}
],
"positions": {
"1": {
"market_id": 101,
"symbol": "BTC-USD",
"initial_margin_fraction": "0.1",
"open_order_count": 2,
"pending_order_count": 1,
"sign": 1,
"position": "0.5",
"avg_entry_price": "20000.00",
"position_value": "10000.00",
"unrealized_pnl": "500.00",
"realized_pnl": "100.00"
}
},
"shares": [
{
"public_pool_index": 1,
"shares_amount": 100,
"entry_usdc": "1000.00"
}
],
"trades": {
"1": [
{
"trade_id": 401,
"tx_hash": "0xabc123456789",
"type": "buy",
"market_id": 101,
"size": "0.5",
"price": "20000.00",
"usd_amount": "10000.00",
"ask_id": 501,
"bid_id": 502,
"ask_account_id": 123456,
"bid_account_id": 654321,
"is_maker_ask": true,
"block_height": 1500000,
"timestamp": 1700000000
}
]
},
"type": "update/account"
}
Account Stats
The account stats channel sends account stats data for the specific account.
{
"type": "subscribe",
"channel": "user_stats/{ACCOUNT_ID}"
}
Example Subscription
{
"type": "subscribe",
"channel": "user_stats/0"
}
Response Structure
{
"channel": "user_stats:{ACCOUNT_ID}",
"stats": {
"collateral": STRING,
"portfolio_value": STRING,
"leverage": STRING,
"available_balance": STRING,
"margin_usage": STRING,
"buying_power": STRING
},
"type": "update/user_stats"
}
Example Response
{
"channel": "user_stats:10",
"stats": {
"collateral": "5000.00",
"portfolio_value": "15000.00",
"leverage": "3.0",
"available_balance": "2000.00",
"margin_usage": "0.80",
"buying_power": "4000.00"
},
"type": "update/user_stats"
}
Transaction
The transaction channel sends all new transactions.
{
"type": "subscribe",
"channel": "transaction"
}
Response Structure
{
"channel": "transaction",
"txs": [
{
"hash": STRING,
"type": INTEGER,
"info": {
"AccountIndex": INTEGER,
"ApiKeyIndex": INTEGER,
"MarketIndex": INTEGER,
"Index": INTEGER,
"BaseAmount": INTEGER,
"Price": INTEGER,
"TriggerPrice": INT,
"ExpiredAt": INTEGER,
"Nonce": INTEGER,
"Sig": STRING
},
"event_info": STRING,
"status": INTEGER,
"transaction_index": INTEGER,
"l1_address": STRING,
"account_index": INTEGER,
"nonce": INTEGER,
"expire_at": INTEGER,
"block_height": INTEGER,
"queued_at": INTEGER,
"executed_at": INTEGER,
"sequence_index": INTEGER,
"parent_hash": STRING
}
],
"type": "update/transaction"
}
Example Response
{
"channel": "transaction",
"txs": [
{
"hash": "0xabc123456789def",
"type": 1,
"info": {
"AccountIndex": 101,
"ApiKeyIndex": 202,
"MarketIndex": 303,
"Index": 404,
"BaseAmount": 1000,
"Price": 50000,
"TriggerPrice": 49000,
"ExpiredAt": 1700000000,
"Nonce": 12345,
"Sig": "0xsigexample"
},
"event_info": "Trade executed",
"status": 2,
"transaction_index": 10,
"l1_address": "0x123abc456def789",
"account_index": 101,
"nonce": 12345,
"expire_at": 1700000000,
"block_height": 1500000,
"queued_at": 1699999990,
"executed_at": 1700000005,
"sequence_index": 5678,
"parent_hash": "0xparenthash123456"
}
],
"type": "update/transaction"
}
Executed Transaction
The structure is the same as with Transaction channel. But this channel sends only executed transactions.
{
"type": "subscribe",
"channel": "executed_transaction"
}
Updated about 2 months ago