ZigZag API

URLs

Mainnet

Websocket Base URL: wss://zigzag-exchange.herokuapp.com
HTTPS Base URL: https://zigzag-exchange.herokuapp.com

Rinkeby

Websocket Base URL: wss://secret-thicket-93345.herokuapp.com
HTTPS Base URL: https://secret-thicket-93345.herokuapp.com

Chain IDs

The following is a list of Zigzag Chain IDs. Note that there is no relation between this and Ethereum Chain IDs.

IDs < 1000 are mainnet contracts. IDs >= 1000 are testnet contracts.

Websocket vs REST

Our API is designed to be used as a Websocket API. The message structures and response methods are optimized for Websocket use. However, we understand in some cases a REST API is just more convenient, so a couple select methods in our API are available over HTTP POST.

The HTTP POST API uses the same endpoint as the websocket API. It is a single endpoint API where messages are passed in the exact same structure as the Websocket message. See Structure for how POST and Websocket messages should be structured.

The current list of operations available over HTTP POST are: submitorder3, requestquote, orderreceiptreq, refreshliquidity, dailyvolumereq and marketsreq.

Sending orders on zksync

The Zksync limit order system is pretty complicated, so we've simplified it down into an RFQ.

There's a requestquote operation you can use to get an all in price including gas fees charged for relaying. The smaller the amount, the further away from spot it's going to be because of the variable fee.

Using the price from the quote response, you can send a limit order with submitorder3. An order sent at the quote price will fill like a market order.

Structure

All messages the Zigzag Websocket API have the following structure

{ "op": "operation", "args": ["list", "of", "args"] }

Messages to the HTTP POST API have a similar structure. An example curl command is found below.

curl -X POST "https://zigzag-exchange.herokuapp.com/" --header "Content-Type: application/json" -d '{"op":"requestquote", "args": [1000, "ETH-USDT", "b", "0.232"]}'

Limitations

Currently a user can only receive order updates on one connection at a time per chain. This may be upgraded in the future.

Pings

The server sends a ping message every 10 seconds to assure the connection is alive. A pong response is expected in return.

Most websocket clients handle the ping message automatically, so no extra work should be required on your part.

Dead connections are auto closed.

Order Statuses

Operations

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: submitorder3

Arguments: [chainId, market, 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.

This operation is also available over HTTP POST and returns a userorderack message.

Zksync

{
  "op": "submitorder3",
  "args": [
    1000,
    "ETH-DAI",
    {
      "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": "submitorder3",
  "args": [
    1001,
    "ETH-USDT",
    [
      "1001",
      "0xe386d09808b7b87507e6483deea09a32c688ef47616416c967d639d1283bc0",
      "0x06a75fdd9c9e376aebf43ece91ffb315dbaa753f9c0ddfeb8d7f3af0124cd0b6",
      "0x03d3af6e3567c48173ff9b9ae7efc1816562e558ee0cc9abc0fe1862b2931d9a",
      "0",
      "25252900000000000",
      "1",
      "211376718",
      "1638413195932",
      "239163444802039150939555844808313706381087721975693276317756200101630683732",
      "3563164837021092402584684943417251345107665423524603528021630345938863767190"
    ]
  ]
}

Operation: indicateliq2

Arguments: [chainId, market, liquidity]

liquidity = [[side, price, baseQuantity, expires], ...]

Description: Used by market makers to indicate liquidity. side = {"b","s"} (buy, sell).

Expiration is a UNIX timestamp in seconds. If an expiration is not set or is set to greater than 15 seconds, it is defaulted to 15 seconds.

{
  "op": "indicateliq2",
  "args": [
    1000,
    "ETH-USDT",
    [
      ["b", 3100, 1.2322, 1642677967],
      ["b", 3200, 2.2324, 1642677967],
      ["s", 3300, 0.2822, 1642677967],
      ["s", 3500, 1.2832, 1642677967]
    ]
  ]
}

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 YET

Operation: orderreceiptreq

Arguments: [chainid,orderid]

Description: Get an order receipt. Returns a message with the same format as userorderack, but with one extra field at the end for the transaction hash.

{ "op": "orderreceiptreq", "args": [1000, 40] }

Operation: 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",
        0.1
      ],
      [
        1000,
        6,
        "ETH-USDT",
        "s",
        3380.93,
        0.1,
        338.093,
        4294967295,
        "24",
        "pf",
        0.05
      ],
      [
        1000,
        7,
        "ETH-USDT",
        "b",
        3350.93,
        0.001,
        3.35093,
        4294967295,
        "174",
        "pm",
        0.02
      ]
    ]
  ]
}

Operation: fills

Arguments: [fills]

Description: Latest fills for a market. order = [chainId,id,market,side,price,baseQuantity,fillstatus,txhash,takeruserid,makeruserid,feeamount,feetoken,timestamp]

{
  "op": "fills",
  "args": [
    [
      [
        1001,
        402,
        "ETH-USDT",
        "s",
        4406.829995978547,
        0.0677283,
        "f",
        "0xe5e306e147d21740c9798e31b764cd65de148f8df41359693b6ed1cfeff527",
        "0xe386d09808b7b87507e6483deea09a32c688ef47616416c967d639d1283bc0",
        "0xa74303fe0bc93dac0e702c96b854914dc7fe2c8e04db6903fcee2dec38a4ba",
        0.48,
        "USDC",
        1646476058552
      ],
      [
        1001,
        401,
        "ETH-USDT",
        "b",
        4405.759991924418,
        0.0322717,
        "f",
        "0x55c01db07f251fa539ae0e2fa61a8a275af6f4ca57fda5044f54b1e8ca0dd66",
        "0xe386d09808b7b87507e6483deea09a32c688ef47616416c967d639d1283bc0",
        "0xa74303fe0bc93dac0e702c96b854914dc7fe2c8e04db6903fcee2dec38a4ba",
        0.000072,
        "ETH",
        1646476027148
      ],
      [
        1001,
        400,
        "ETH-USDT",
        "s",
        4405.759991924418,
        0.0647607,
        "f",
        "0x4387a5860db3b3b028ba277fadf5c309c595664359f6c2b267d2eac9e106459",
        "0xe386d09808b7b87507e6483deea09a32c688ef47616416c967d639d1283bc0",
        "0xa74303fe0bc93dac0e702c96b854914dc7fe2c8e04db6903fcee2dec38a4ba",
        0.203,
        "DAI",
        1646475999960
      ]
    ]
  ]
}

Operation: orderstatus

Arguments: [orderupdates]

Description: A series of order status updates. orderupdate = [chainId,orderId,status,txHash,remaining]. See Order Status for status flags.

{
  "op": "orderstatus",
  "args": [
    [
      [1000, 5, "m", 4700.23],
      [
        1000,
        890013,
        "f",
        "51c23f8bcb7aa2cc64c8da28827df6906b8bdc53818eaf398f5198a6850310f0",
        null
      ]
    ]
  ]
}

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: fillstatus

Description: An update about the fill status of an active order. fillstatus = [chainId,fillId,status,txHash,remaining,feeamount,feetoken,timestamp]. See Order Status for status flags.

{
  "op": "fillstatus",
  "args": [
    [
      [
        1000,
        9258,
        "f",
        "51c23f8bcb7aa2cc64c8da28827df6906b8bdc53818eaf398f5198a6850310f0",
        null,
        0.000072,
        "ETH",
        1646476058552
      ]
    ]
  ]
}

Operation: liquidity2

Arguments: [chainId, market, liquidity]

Description: Indications of market maker interest. liquidity = [side,price,baseQuantity]

{
  "op": "liquidity2",
  "args": [
    1000,
    "ETH-USDT",
    [
      ["b", 3100, 1.2322],
      ["b", 3200, 2.2324],
      ["s", 3300, 0.2822],
      ["s", 3500, 1.2832]
    ]
  ]
}

Operation: refreshliquidity

Arguments: [chainId, market]

Description: Liquidity is usually sent out every 3-5 seconds. If you want it more often than that you can use this to get a fresh snapshot.

Available over REST.

{ "op": "refreshliquidity", "args": [1000, "ETH-USDT"] }

Operation: lastprice

Arguments: [priceUpdates]

Description: A group of market price updates. priceUpdate = [market,price,change,quoteVolume]

{
  "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

To unsubscibe from all markets, you can leave the args empty: "args": []

{ "op": "unsubscribemarket", "args": [1000, "ETH-USDT"] }

Operation: userorderack

Arguments: [chainId,id,market,side,price,baseQuantity,quoteQuantity,expires,userid,orderstatus,remaining]

Description: ack message for a submitorder3 message

{
  "op": "userorderack",
  "args": [
    1000,
    5,
    "ETH-USDT",
    "s",
    3370.93,
    0.1,
    337.093,
    4294967295,
    "23",
    "o",
    0.1
  ]
}

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 available

Operation: cancelorder

Arguments: [chainId, orderId]

Description: Cancel an order

{ "op": "cancelorder", "args": [1000, 122] }

Operation: cancelall

Arguments: [chainId,userId]

Description: Cancel all orders for a user

{ "op": "cancelall", "args": [1000, "12232"] }

Operation: requestquote

Arguments: [chainid, market, side, baseQuantity, quoteQuantity]

Description: Request a quote for a purchase. Quotes are all in prices including gas fees, so they may differ from the market price substantially.

Only one of baseQuantity or quoteQuantity should be set.

This operation is also available over HTTP POST and returns a quote message.

{ "op":"requestquote", "args": [1, "ETH-USDT", "b", "0.032"] }
{ "op":"requestquote", "args": [1, "ETH-USDT", "b", "0.032", null] }
{ "op":"requestquote", "args": [1, "ETH-USDT", "b", null, "2000"] }

Operation: quote

Arguments: [chainid, market, side, baseQuantity, price, quoteQuantity]

Description: Response to requestquote. Returns a fully filled quote with baseQuantity, price, and quoteQuantity. The price can then be used with submitorder3 to ensure a fill.

{ "op": "quote", "args": [1, "ETH-USDT", "b", 0.032, "4900", "156.8"] }

Operation: marketinfo

Arguments: [marketInfoJson]

Description: Returns a standard market info JSON from the Zigzag Markets API. Returned on every subscribemarket call

{
  "op": "marketinfo",
  "args": [
    {
      "baseAssetId": "65",
      "quoteAssetId": "1",
      "baseFee": 1,
      "quoteFee": 1,
      "minSize": 1,
      "maxSize": 100,
      "zigzagChainId": 1,
      "pricePrecisionDecimal": 6,
      "baseAsset": {
        "id": 65,
        "address": "0x19ebaa7f212b09de2aee2a32d40338553c70e2e3",
        "symbol": "ARTM",
        "decimals": 18,
        "enabledForFees": false
      },
      "quoteAsset": {
        "id": 1,
        "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
        "symbol": "DAI",
        "decimals": 18,
        "enabledForFees": true
      },
      "id": "nORHCLNmmeS5Cp5or2Xt4gMMovgfVsbwYXA941zq0ks",
      "alias": "ARTM-DAI"
    }
  ]
}

Operation: marketinfo2

A marketinfo2 message is the same as a marketinfo message but it contains information for multiple markets instead of 1.

It's returned by calling marketsreq with the detailed flag turned on.

{
  "op": "marketinfo2",
  "args": [
    [
      {
        "baseAssetId": "65",
        "quoteAssetId": "1",
        "baseFee": 1,
        "quoteFee": 1,
        "minSize": 1,
        "maxSize": 100,
        "zigzagChainId": 1,
        "pricePrecisionDecimal": 6,
        "baseAsset": {
          "id": 65,
          "address": "0x19ebaa7f212b09de2aee2a32d40338553c70e2e3",
          "symbol": "ARTM",
          "decimals": 18,
          "enabledForFees": false
        },
        "quoteAsset": {
          "id": 1,
          "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
          "symbol": "DAI",
          "decimals": 18,
          "enabledForFees": true
        },
        "id": "nORHCLNmmeS5Cp5or2Xt4gMMovgfVsbwYXA941zq0ks",
        "alias": "ARTM-DAI"
      }
    ]
  ]
}

Operation: marketsreq

Arguments: [chainid, detailed]

Description: Request a list of markets. Available over REST. Response is a markets message if detailed flag is unset, or a marketinfo2 message if the detailed flag is set.

{"op":"marketsreq","args":[1]}
{"op":"marketsreq","args":[1, true]}

curl "https://zigzag-exchange.herokuapp.com/" -X POST -H 'Content-Type:application/json' -d '{"op":"marketsreq","args":[1, true]}'

Operation: markets

Arguments: [markets]. market = [marketId,lastPrice,priceChange24h]

Description: Request a list of markets. Available over REST. Response is a markets message.

{
  "op": "markets",
  "args": [
    [
      ["ETH-USDT", "3500", 120],
      ["ETH-USDC", "3500", 122],
      ["USDC-USDT", "0.9993", 0.0001]
    ]
  ]
}

Operation: dailyvolumereq

Arguments: [chainreq]

Description: Request daily volumes by pairs.

Available over HTTP.

{ "op": "dailyvolumereq", "args": [1000] }

curl "https://zigzag-exchange.herokuapp.com/" -H 'Content-Type:application/json' -d '{"op":"dailyvolumereq", "args":[1000]}'

Operation: dailyvolume

Arguments: [volumes]. volume = [chainid,market,date,baseVolume,quoteVolume]

Description: Daily volume by pair.

{
  "op": "dailyvolume",
  "args": [
    [
      [
        1001,
        "ETH-USDT",
        "2021-11-28T18:30:00.000Z",
        14.5387724,
        63882.260941443
      ],
      [1000, "USDC-USDT", "2022-01-16T18:30:00.000Z", 115, 119.99047],
      [1, "WBTC-USDT", "2021-12-05T18:30:00.000Z", 1.927e-5, 1.93041]
    ]
  ]
}

Operation: error

Arguments: [operation, error]

Description: Error message from a requested operation

{ "op": "error", "args": ["fillrequest", "Order 234 is not open"] }

zigzag endpoints

/api/v1/markets

Example: /api/v1/marketsor /api/v1/markets?market=eth-ust

Arguments: ?market=ETH-UST (optional, like: /api/v1/markets?market=eth-ust)

Description: Returns a JSON containing all markets. If an argument is set, it will only return that summary.

{
  "USDC-USDT":
    {
      "market":"USDC-USDT",
      "baseSymbol":"USDC",
      "quoteSymbol":"USDT",
      "lastPrice":0.99985,
      "lowestAsk":1.00024994,
      "highestBid":0.99945006,
      "baseVolume":1801.15,
      "quoteVolume":1800.88,
      "priceChange":-0.002004,
      "priceChangePercent_24h":-0.002004,
      "highestPrice_24h":1.001854,
      "lowestPrice_24h":0.99805
    },
  "DAI-USDT": 
  ....
}  

/api/v1/ticker

Example: /api/v1/tickeror /api/v1/ticker?market=eth-ust

Arguments: ?market=ETH-UST (optional, like: /api/v1/ticker?market=eth-ust)

Description: Returns a JSON containing all price information. If an argument is set, it will only return this price information.

{
  "USDC-USDT":
    {
      "lastPrice":0.99985,
      "priceChange":-0.002004,
      "baseVolume":"2614.65",
      "quoteVolume":"2614.26"
    },
  "DAI-USDT":
  ...
}

/api/v1/orderbook/:market

Example: /api/v1/orderbook/eth-ust?depth=5&level=3

Arguments:

• :market
• ?depth (optional)
• ?level (optional)

Description: Returns a JSON containing all orderbook informations for that market. The volume is in the corresponding base asset.

• With depth you can set how many orders you want to aggregate. If you set 50, that returns 25 per ask/bid.
• With level you can set the returned level:
  • 1 -> best bid and ask
  • 2 -> bids and asks aggregated by 0.05% steps
  • 3 -> full order book with every bid and ask

{
  "timestamp": 1646402828755,
  "bids": [
    [3000, 1],
    [2999, 2],
    ...
  ],
  "asks": [
    [3010, 1],
    [3011, 2],
    ...
  ]
}

/api/v1/trades/

Example: /api/v1/trades?market=eth-ust&type=s&order_id=4518

Arguments:

• ?market (optional)
• ?type (optional)
• ?limit (optional)
• ?order_id (optional)
• ?start_time (optional in UNIX)
• ?end_time (optional in UNIX)
• ?account_id (optional)
• ?direction (optional - 'older' or 'newer')

Description: Returns a JSON containing the last trades in decending order.

• With market you can choose to only return trades for one market. Use 'eth-ust' or 'eth_ust'
• With type you can choose to only return buy or ask side. You can set 's', 'b', 'sell' or 'buy'.
• With limit you can set the maximum number of trades returned. MAX 25 for now.
• With order_id you can set the first order you want to get returned. This can be used to loop over all trades. Use the last orderId returned from the last request and send that as first order_id.
• With start_time you can set the first retuned trade. Set using UNIX time.
• With end_time you can set the last retuned trade. Set using UNIX time.
• With account_id you can get trades corresponding to a given account ID.
• With direction you set the direction, best used together with a account_id (eg. get all new trades starting from x)

.

[
  {
    "chainId":1000,
    "orderId":4162,
    "market":"ETH-USDC",
    "price":2914.15,
    "baseVolume":0.09966024999,
    "quoteVolume":290.42491750835853,
    "timestamp":1646307989024,
    "side":"sell",
    "txHash":"3e870f76771a37e9da5d0d3d82c3d0a83699e359254c0c2fb4c0aee8fe64a01f",
    "takerId": 674945,
    "makerId": 354861,
    "feeAmount":0.00003025,
    "feeToken":"ETH"
  },
  {
    "chainId":1000,
    ....
  }
]