For testing use:\nhttps://api.stage.coinzoom.com/api/v1/public
\nFor production use:\nhttps://api.coinzoom.com/api/v1/public
\nEach API must include the HTTP header 'Coinzoom-Api-Key' with the value of your API key. These keys can be created within the the CoinZoom exchange from the 'API Trading' menu. To create your key you will need to complete registration for a CoinZoom Account:
\nFor testing register here:\nhttps://stage.coinzoom.com
\nFor production register here:\nhttps://trade.coinzoom.com
\nRequests to the API with a missing User-Agent header will be rejected. We are requiring that the User-Agent contains your ZoomMe: username.
\nExample:
\nUser-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36 ZoomMe: your_handle
Total requests to the API endpoints are limited to 120 RPM. Requests to https://stage.coinzoom.com and https://trade.coinzoom.com may have a lower RPM value. Repeatedly violating CoinZoom's API rate limits and/or failing to back off after receiving 429's can result in an automated IP ban. Repeated violations can result in account ban.
\nRest-API Total RPM: 120 RPM
\nGet currencies: 12 RPS
\nGet pairs: 12 RPM
\nQuery ledger balances: 60 RPM
\nPlace limit order: 60 RPM
\nPlace market order: 60 RPM
\nPlace stop limit order: 60 RPM
\nCancel order: 60 RPM
\nQuery open orders: 30 RPM
\nQuery historic orders: 60 RPM
\nStreaming Websocket API: 30 RPM
\nThe streaming websocket is available at these following endpoints:
\nFor testing use:\nwss://api.stage.coinzoom.com/api/v1/public/market/data/stream
\nFor production use:\nwss://api.coinzoom.com/api/v1/public/market/data/stream
\nThe data items that can be received on this socket are described in the following subsections. You can subscribe to any combination of data items as you want on the socket.
\nNote: when using the websocket, open a connection and send the relevant subscriptions. After that keep the socket open. It is recommended to that you only close and reopen the socket if it is disconnected unexpectedly. Our firewalls may block repeated opening and closing of socket connections and may result in an automatic IP ban.
\nTo receive updates on the market for a given symbol send this JSON packet with the appropriate symbol name. This is unsecured request so the API and secret keys are not needed.
\n{\"MarketSummaryRequest\":{\"action\":\"subscribe\",\"symbol\":\"BTC/USD\"}}
To stop receiving this data send the message:
\n{\"MarketSummaryRequest\":{\"action\":\"unsubscribe\",\"symbol\":\"BTC/USD\"}}
Responses are in the format below. The values in the array are the symbol, opening price, high price, low price, current mid price, volume traded, current best bid price, current best ask price respectively. These values are for a moving 24 hour window ending at the current time:
\n{\"ms\":[\"BTC/USD\",6898.3,7254.76,6600.36,7207.06,0.0,7195.53,7218.58]}
To receive the order book for a given symbol send this JSON packet with the appropriate symbol name. This is unsecured request so the API and secret keys are not needed.
\n{\"OrderBookRequest\":{\"requestId\":\"BTC/USD\",\"action\":\"subscribe\",\"symbol\":\"BTC/USD\",\"aggregate\":false,\"depth\":0}}
To stop receiving this data send the message:
\n{\"OrderBookRequest\":{\"requestId\":\"BTC/USD\",\"action\":\"unsubscribe\",\"symbol\":\"BTC/USD\"}}
The responses come in two forms. A full order book, and incremental updates to this. You should receive a full order book message first.
\nAn example of a full message is below. The b and s arrays contain the buy and sell sides of the order book. Each individual buy and sell is an array of three values - id, price, amount. The id is used for the incremental updates:
{\"ob\":\"BTC/USD\",\"b\":[[\"3\",0.01,0.0100001],[\"5\",7193.07,6.95113491],[\"9\",7195.95,0.69483529]],\"s\":[[\"1\",7221.88,6.92340499],[\"2\",7219.0,0.69261671]]}
An example of an incremental message is below. If a buy or sell only contains the id it is an instruction to delete that record from the order book. Otherwise it is an instruction to add it to the book or update it if it is already there.
\n{\"oi\":\"BTC/USD\",\"b\":[[\"9\"],[\"5\"],[\"7\",7193.27,6.95094164],[\"8\",7196.15,0.69481598]],\"s\":[[\"2\"],[\"1\"],[\"4\",7222.08,6.92321326],[\"6\",7219.2,0.69259752]]}
To receive candles for a given symbol send this JSON packet with the appropriate symbol name. This is unsecured request so the API and secret keys are not needed. The supported intervals are M1 (one minute), M5 (Five minutes), M15 (Fifteen minutes), M30 (Thirty minutes), H1 (One hour), H2 (Two hour), H4 (Four hour), D1 (One day), W1 (One week), L1 (One month).
\n{\"CandleRequest\":{\"action\":\"subscribe\",\"symbol\":\"BTC/USD\",\"interval\":\"M1\"}}
To stop receiving this data send the message:
\n{\"CandleRequest\":{\"action\":\"unsubscribe\",\"symbol\":\"BTC/USD\",\"interval\":\"M1\"}}
An example of the response message is below. The values in the c array are timestamp, opening price, low price, high price, closing price, volume.
{\"cu\":\"BTC/USD\",\"i\":\"M1\",\"c\":[[\"2019-11-26T00:51:00Z\",7140.68,7149.15,7140.51,7145.5,0.0]]}
To receive the trade history for a given symbol send this JSON packet with the appropriate symbol name. This is unsecured request so the API and secret keys are not needed.
\n{\"TradeSummaryRequest\": {\"action\": \"subscribe\", \"symbol\": \"BTC/USD\"}}
To stop receiving this data send the message:
\n{\"TradeSummaryRequest\": {\"action\": \"unsubscribe\", \"symbol\": \"BTC/USD\"}}
An example of the response message is below. The values in the array are the symbol, price, quantity and timestamp. The data represents a summary of all trades over a time period of approximately half a second. The quantity is the cumulative quantity of all trades in that period. The price is the weighted average price (weighted by trade quantity). If there have been no trades a message will not be sent on the socket.
\n{\"ts\": [\"BTC/USD\", 8772.05, 0.01, \"2020-01-16T21:02:23Z\"]}
To receive updates on your orders send this JSON packet
\n{\"OrderUpdateRequest\":{\"action\":\"subscribe\",\"apiKey\":\"your key\",\"secretKey\":\"your secret\"}}
Sample responses for a successfully filled market order are:
\n{\"OrderResponse\":{\"orderId\":\"300e0bb8-3c6b-417e-b3fb-b6197ff3a907\",\"clientOrderId\":\"my-id-3\",\"symbol\":\"ETH/USD\",\"orderType\":\"MARKET\",\"orderSide\":\"BUY\",\"quantity\":3.14,\"executionType\":\"NEW\",\"orderStatus\":\"NEW\",\"lastQuantity\":0,\"leavesQuantity\":3.14,\"cumulativeQuantity\":0,\"transactTime\":\"2019-11-14T21:15:55.860601Z\"}}
{\"OrderResponse\":{\"id\":\"26dbbb12-fd7a-4e0f-9f1a-7ffd1582e5c5\",\"orderId\":\"300e0bb8-3c6b-417e-b3fb-b6197ff3a907\",\"clientOrderId\":\"my-id-3\",\"symbol\":\"ETH/USD\",\"orderType\":\"MARKET\",\"orderSide\":\"BUY\",\"quantity\":3.14,\"executionType\":\"FILL\",\"orderStatus\":\"FILLED\",\"lastPrice\":184.96,\"averagePrice\":184.96,\"lastQuantity\":3.14,\"leavesQuantity\":0,\"cumulativeQuantity\":3.14,\"transactTime\":\"2019-11-14T21:15:56.280367Z\"}}
Sample responses for a successfully cancelled order are:
\n{\"OrderCancelResponse\":{\"orderId\":\"7a8514a8-a977-400c-a628-f70c4c182186\",\"response\":\"Cancel Pending\",\"symbol\":\"ETH/USD\"}}
{\"OrderResponse\":{\"id\":\"52e367f7-a81a-4ae8-bff8-3e3fdf95b9d9\",\"orderId\":\"7a8514a8-a977-400c-a628-f70c4c182186\",\"symbol\":\"ETH/USD\",\"orderType\":\"LIMIT\",\"orderSide\":\"BUY\",\"price\":120,\"quantity\":10,\"executionType\":\"CANCEL\",\"orderStatus\":\"CANCELLED\",\"lastQuantity\":0,\"leavesQuantity\":0,\"cumulativeQuantity\":0,\"transactTime\":\"2019-11-14T21:13:21.954453Z\"}}
The note is optional and can contain up to 30 characters.
\n","urlObject":{"path":["api","v1","public","orders","new"],"host":["{{coinzoomHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f70b80e-bec2-4b1b-b305-bc4f4c8fa83a"},{"name":"Place market order","id":"233c9d9f-7009-4539-99cb-926535385c82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Coinzoom-Api-Key","value":"{{coinzoomApiKey}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Coinzoom-Api-Secret","value":"{{coinzoomSecretKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"symbol\": \"ZOOM/USD\",\n\t\"orderType\": \"MARKET\",\n\t\"orderSide\": \"BUY\",\n\t\"quantity\": 20,\n\t\"payFeesWithZoomToken\": true,\n \"note\": \"Sample note.\"\n}","options":{"raw":{"language":"json"}}},"url":"{{coinzoomHost}}/api/v1/public/orders/new","description":"The note is optional and can contain up to 30 characters.
\n","urlObject":{"path":["api","v1","public","orders","new"],"host":["{{coinzoomHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"233c9d9f-7009-4539-99cb-926535385c82"},{"name":"Place stop limit order","id":"91890bbf-88d6-496e-8bb6-da27ea82832a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"body":{"mode":"raw","raw":"{\n\t\"symbol\": \"BTC/USD\",\n\t\"orderType\": \"STOP_LIMIT\",\n\t\"orderSide\": \"BUY\",\n\t\"quantity\": 7.46,\n\t\"price\": 3,\n\t\"stopPrice\": 2,\n\t\"payFeesWithZoomToken\": true,\n \"note\": \"Sample note.\"\n}"},"url":"{{coinzoomHost}}/api/v1/public/orders/new","description":"The note is optional and can contain up to 30 characters.
\n","urlObject":{"path":["api","v1","public","orders","new"],"host":["{{coinzoomHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"91890bbf-88d6-496e-8bb6-da27ea82832a"},{"name":"Place OCO order","id":"7d9899be-b71d-4679-83bf-d203ed95e14a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"body":{"mode":"raw","raw":"{\n\t\"symbol\": \"BTC/USD\",\n\t\"orderSide\": \"SELL\",\n\t\"quantity\": 0.1,\n\t\"limitPrice\": 60000,\n\t\"stopPrice\": 20000,\n\t\"payFeesWithZoomToken\": true,\n \"note\": \"Sample note.\"\n}"},"url":"{{coinzoomHost}}/api/v1/public/orders/oco/new","description":"The note is optional and can contain up to 30 characters.
\n","urlObject":{"path":["api","v1","public","orders","oco","new"],"host":["{{coinzoomHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7d9899be-b71d-4679-83bf-d203ed95e14a"},{"name":"Cancel order","id":"f4cf74ab-7667-4248-978c-d8f0f12bf24c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"body":{"mode":"raw","raw":"{\n\t\"orderId\": \"c13b0253-0994-490f-b5e6-56980d409b91\",\n\t\"symbol\": \"BTC/USD\"\n}"},"url":"{{coinzoomHost}}/api/v1/public/orders/cancel","urlObject":{"path":["api","v1","public","orders","cancel"],"host":["{{coinzoomHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f4cf74ab-7667-4248-978c-d8f0f12bf24c"},{"name":"Query open orders","id":"f2cd7428-482a-4dbe-8c87-3b8c86a6a336","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Coinzoom-Api-Key","type":"text","value":"{{coinzoomApiKey}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Coinzoom-Api-Secret","type":"text","value":"{{coinzoomSecretKey}}"}],"body":{"mode":"raw","raw":"{\n\t\"symbol\": null,\n\t\"orderSide\": null,\n\t\"orderStatuses\": [\"NEW\", \"PARTIALLY_FILLED\"],\n\t\"size\": 100,\n\t\"bookmarkOrderId\": null\n}"},"url":"{{coinzoomHost}}/api/v1/public/orders/list","description":"This request returns a list of your open orders. The values in the orderStatus array can be adjusted to get orders in other statuses. The supported values are NEW, PARTIALLY_FILLED, FILLED, CANCELLED, REJECTED.
\nThe orderSide be one of BUY or SELL. If it is not specified orders from both sides will be returned.
\nThe data is returned in pages. For the initial request pass null in the bookmarkOrderId fields. To get the next page of data pass the orderId of the last entry in the previous call as the bookmarkOrderId.
This request returns a list of your historic orders. The values in the orderStatus array can be adjusted to get orders in other statuses. The supported values are NEW, PARTIALLY_FILLED, FILLED, CANCELLED, REJECTED.
\nThe orderSide be one of BUY or SELL. If it is not specified orders from both sides will be returned.
\nThe data is returned in pages. For the initial request pass null in the bookmarkOrderId fields. To get the next page of data pass the orderId of the last entry in the previous call as the bookmarkOrderId.