Rinkeby Base URL: wss://zigzag-rinkeby.herokuapp.com
Mainnet Base URL: Currently Unsupported
The following is a list of Zigzag Chain IDs. Note that there is no relation between this and Ethereum Chain IDs.
| Name | ID |
|---|---|
| zkSync Mainnet | 1 |
| zkSync Rinkeby | 1000 |
All messages the Zigzag Websocket API have the following structure
{"op":"operation", "args": ["list", "of", "args"]}Currently a user can only receive order updates on one connection at a time per chain. This may be upgraded in the future.
| Shorthand | Status |
|---|---|
| c | canceled |
| o | open |
| e | expired |
| m | matched, but not committed to chain. price listed in args. |
| r | rejected. txhash and error listed in args |
| f | filled and committed. txhash listed in args. |
| b | broadcasted. txhash listed in args. |
| pf | partial fill. quantity and price listed in args. |
| pm | partial match. |
Operation: ping
Arguments: []
Description: You must ping the server atleast every 10 seconds or your connection will be dropped.
{"op":"ping", "args": []}Operation: pong
Arguments: []
Description: Reply to ping message
{"op":"pong", "args": []}Operation: login
Arguments: [chainId, userId]
Description: Associate userId with connection. Note that userId is a string, not an integer, even though zkSync represents account IDs as integers. This is to maintain compatibility with other chains that might use string fields (ETH addresses, ENS account names, etc) for account IDs.
{"op":"login", "args": [1000, "27334"]}Operation: sumbitorder
Arguments: [chainId, zkOrder]
Description: Submit an order.
For zksync, zkOrder is the output of zksync.wallet.getOrder in the Javascript library.
For Starknet, a zkOrder is the calldata for an Order struct in the Zigzag smart contract. For an example of how to send a Starknet order, see the submitorderstarknet function in the helpers file in our frontend.
An example of how to submit an order with Javascript can be found here in the submitorder function.
Zksync
{
"op": "submitorder",
"args": [
1000,
{
"accountId": 202976,
"recipient": "0x88D23A44D07F86B2342B4B06BD88b1ea313B6976",
"nonce": 8,
"amount": "100000000000000000",
"tokenSell": 0,
"tokenBuy": 1,
"validFrom": 0,
"validUntil": 4294967295,
"ratio": [
"1000000000000000000",
"3370930000"
],
"signature": {
"pubKey": "d68168338b475c39bba9efe1451bd17986f0e27cca68232737f2c6953cd6ea9e",
"signature": "43ffeb5e4c6722f6562d7a1946401764bb2de98565df59ecf3a7911c7f3ad615fba49fda67c154c4cd329da35121ceb376f960968c2da615fdb61cd64eb07a04"
},
"ethSignature": {
"type": "EthereumSignature",
"signature": "0x03d07fecdc1cdc5b454c14701007201a49c35b5015dae062c7c2e30c5be44aaf27ff753ee8ee2635035979dd2006ffe4d37f3648da01c755970a70e57245db621b"
}
}
]
}
Starknet
{
"op": "submitorder",
"args": [
1001,
[
"1001",
"0xe386d09808b7b87507e6483deea09a32c688ef47616416c967d639d1283bc0",
"0x06a75fdd9c9e376aebf43ece91ffb315dbaa753f9c0ddfeb8d7f3af0124cd0b6",
"0x03d3af6e3567c48173ff9b9ae7efc1816562e558ee0cc9abc0fe1862b2931d9a",
"0",
"25252900000000000",
"1",
"211376718",
"1638413195932",
"239163444802039150939555844808313706381087721975693276317756200101630683732",
"3563164837021092402584684943417251345107665423524603528021630345938863767190"
]
]
}Operation: indicateliq
Arguments: [chainId, market, spread, side]
Description: Used by market makers to indicate liquidity at a spread from spot price. side = {'b','s','d'} (buy, sell, double-sided)
{"op":"indicatemaker", "args": [1000, "ETH-USDT", 0.003, "d"]}Operation: fillrequest
Arguments: [chainId, orderId, fillOrder]
Description: Fill an open order. fillOrder is the output of zksync.wallet.getOrder. The ratio and tokens in the fillOrder must match the ones of the orderId it is attempting to fill.
{
"op": "fillrequest",
"args": [
1000,
123332,
{
"accountId": 202976,
"recipient": "0x88D23A44D07F86B2342B4B06BD88b1ea313B6976",
"nonce": 8,
"amount": "100000000000000000",
"tokenSell": 0,
"tokenBuy": 1,
"validFrom": 0,
"validUntil": 4294967295,
"ratio": [
"1000000000000000000",
"3370930000"
],
"signature": {
"pubKey": "d68168338b475c39bba9efe1451bd17986f0e27cca68232737f2c6953cd6ea9e",
"signature": "43ffeb5e4c6722f6562d7a1946401764bb2de98565df59ecf3a7911c7f3ad615fba49fda67c154c4cd329da35121ceb376f960968c2da615fdb61cd64eb07a04"
},
"ethSignature": {
"type": "EthereumSignature",
"signature": "0x03d07fecdc1cdc5b454c14701007201a49c35b5015dae062c7c2e30c5be44aaf27ff753ee8ee2635035979dd2006ffe4d37f3648da01c755970a70e57245db621b"
}
}
]
}
Operation: userordermatch
Arguments: `[chainId, takerOrder, makerOrder]
Description: Indicates a successful fillrequest. Matched orders should be broadcasted by the client using zksync.wallet.syncSwap
NO EXAMPLE AVAILABLE YETOperation: orders
Arguments: [orders]
Description: Current open orders for a market. order = [chainId,id,market,side,price,baseQuantity,quoteQuantity,expires,userid,orderstatus,remaining]
{
"op": "orders",
"args": [
[
[ 1000, 5, "ETH-USDT", "s", 3370.93, 0.1, 337.093, 4294967295, "23", "o", null, 0.1 ],
[ 1000, 6, "ETH-USDT", "s", 3380.93, 0.1, 338.093, 4294967295, "24", "pf",null, 0.05 ],
[ 1000, 7, "ETH-USDT", "b", 3350.93, 0.001, 3.35093, 4294967295, "174", "pm", null, 0.02 ]
]
]
}Operation: fills
Arguments: [fills]
Description: Latest fills for a market. order = [chainId,id,market,side,price,baseQuantity,fillstatus,txhash,takeruserid,makeruserid]
{
"op":"fills",
"args":[
[
[1001,402,"ETH-USDT",'s',4406.829995978547,0.0677283,"f","0xe5e306e147d21740c9798e31b764cd65de148f8df41359693b6ed1cfeff527","0xe386d09808b7b87507e6483deea09a32c688ef47616416c967d639d1283bc0","0xa74303fe0bc93dac0e702c96b854914dc7fe2c8e04db6903fcee2dec38a4ba"],
[1001,401,"ETH-USDT",'b',4405.759991924418,0.0322717,"f","0x55c01db07f251fa539ae0e2fa61a8a275af6f4ca57fda5044f54b1e8ca0dd66","0xe386d09808b7b87507e6483deea09a32c688ef47616416c967d639d1283bc0","0xa74303fe0bc93dac0e702c96b854914dc7fe2c8e04db6903fcee2dec38a4ba"],
[1001,400,"ETH-USDT",'s',4405.759991924418,0.0647607,"f","0x4387a5860db3b3b028ba277fadf5c309c595664359f6c2b267d2eac9e106459","0xe386d09808b7b87507e6483deea09a32c688ef47616416c967d639d1283bc0","0xa74303fe0bc93dac0e702c96b854914dc7fe2c8e04db6903fcee2dec38a4ba"]
]
]
}Operation: orderstatus
Arguments: [orderupdates]
Description: A series of order status updates. orderupdate = [chainId,orderId,status,...args]
{
"op": "orderstatus",
"args": [[
[ 1000, 5, "m", 4700.23]
]]
}Operation: orderstatusupdate
Arguments: [orderupdates]
Description: Used by market makers to submit chain commitment information on a matched order. orderupdate = [chainId,orderId,status,...args]
Only 'f' and 'r' status updates are permitted, and only for matched orders.
{
"op": "orderstatusupdate",
"args": [[
[ 1000, 5, "f", 4700.23, "9ddba58f75a6b8e65828c2fb5e7e6d80001fccbd6ce0c931181dfdcdb4721162"]
]]
}
---
Operation: **liquidity**
Arguments: `[chainId, market, liquidity]`
Description: Indications of market maker interest by spread. liquidity = [quantity,spread,side]
```json
{
"op": "liquidity",
"args": [
1000,
"ETH-USDT",
[
[ 0.1, 0.003, "d" ],
[ 0.5, 0.005, "d" ]
]
]
}
Operation: lastprice
Arguments: [priceUpdates]
Description: A group of market price updates. priceUpdate = [market,price,change]
{
"op": "lastprice",
"args": [
[
[ "ETH-BTC", 0.069431, 0.0023 ],
[ "ETH-USDT", 2989.19, 43.1 ],
[ "BTC-USDT", 43048, 2003.2 ]
]
]
}Operation: marketsummary
Arguments: [chainId,market,price,24hi,24lo,pricechange,baseVolume,quoteVolume]
Description: Price action summary over the last 24 hours
{"op":"marketsummary","args":["ETH-USDT",2989.19,3048.42,2782,149.06,100,300000]}Operation: subscribemarket
Arguments: [chainId,market]
Description: Subscribe to orderbook and price data for a market
{"op":"subscribemarket","args":[1000,"ETH-USDT"]}Operation: unsubscribemarket
Arguments: [chainId,market]
Description: Unsubscribe from a market
{"op":"unsubscribemarket","args":[1000,"ETH-USDT"]}Operation: userorderack
Arguments: [chainId,id,market,side,price,baseQuantity,quoteQuantity,expires]
Description: ack message for a submitorder message
{ "op":"userorderack", "args": [1000,5,"ETH-USDT","s",3370.93,0.1,337.093,4294967295]}Operation: userordermatch
Arguments: [orderId,zkOrder,zkFillOrder]
Description: Indicates that an order match has occurred and requests the user to broadcast the swap to the chain
No example availableOperation: cancelorder
Arguments: [orderId]
Description: Cancel an order
{ "op":"cancelorder", "args": [122] }Operation: cancelall
Arguments: [chainId,userId]
Description: Cancel all orders for a user
{ "op":"cancelall", "args": [1000, "12232"] }Operation: cancelorderack
Arguments: [canceledIds]
Description: Ack messasge for canceled orders with a list of canceled IDs
{ "op":"cancelorderack", "args": [[1,8,99,323]] }
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent