Trades
Gets trade histories of the specified symbol. After subscribing, trade histories start to be sent.
WebSocket Endpoint
wss://api.coin.z.com/ws/public/v1
Connection Details
- A ping will be sent from the server to a client once per minute
- If there's no response (pong) from a client 3 consecutive times, the WebSocket will be disconnected automatically
Subscribe Message
Parameters
Parameter type: JSON
| Property Name | Type | Required | Available Values |
|---|---|---|---|
| command | string | Required | subscribe/unsubscribe |
| channel | string | Required | trades |
| symbol | string | Required | The handling symbols |
| option | string | Optional | TAKER_ONLY |
Notes:
- If
optionis specified, it will send taker data only - If you request multiple trade subscriptions with the same symbol, only the latest request will be valid
Example
{
"command": "subscribe",
"channel": "trades",
"symbol": "BTC"
}
Response Format
Fields
| Property Name | Value | Description |
|---|---|---|
| channel | string | trades |
| price | string | Executed price |
| side | string | Side: BUY/SELL |
| size | string | Executed quantity |
| timestamp | string | Executed timestamp |
| symbol | string | The handling symbols |
Example Response
{
"channel": "trades",
"price": "750760",
"side": "BUY",
"size": "0.1",
"timestamp": "2018-03-30T12:34:56.789Z",
"symbol": "BTC"
}
Note: There is no Response when unsubscribe is requested.
Code Examples
JavaScript (Node.js)
const WebSocket = require("ws");
const ws = new WebSocket("wss://api.coin.z.com/ws/public/v1");
ws.on("open", () => {
const message = JSON.stringify({
"command": "subscribe",
"channel": "trades",
"symbol": "BTC"
});
ws.send(message);
});
ws.on("message", (data) => {
console.log("WebSocket message: ", data);
});
Python
import json
import websocket
websocket.enableTrace(True)
ws = websocket.WebSocketApp('wss://api.coin.z.com/ws/public/v1')
def on_open(self):
message = {
"command": "subscribe",
"channel": "trades",
"symbol": "BTC"
}
ws.send(json.dumps(message))
def on_message(self, message):
print(message)
ws.on_open = on_open
ws.on_message = on_message
ws.run_forever()
Go
package main
import (
"fmt"
"golang.org/x/net/websocket"
"encoding/json"
"bytes"
)
func main() {
wsUrl := "wss://api.coin.z.com/ws/public/v1"
origin := "https://api.coin.z.com"
sendMsg := (`{
"command": "subscribe",
"channel": "trades",
"symbol": "BTC"
}`)
var receiveMsg string
ws, _ := websocket.Dial(wsUrl, "", origin)
websocket.Message.Send(ws, sendMsg)
for {
websocket.Message.Receive(ws, &receiveMsg)
var buf bytes.Buffer
json.Indent(&buf, []byte(receiveMsg), "", " ")
fmt.Println(buf.String())
}
}
Ruby
require "faye/websocket"
require "eventmachine"
require 'json'
EM.run {
ws = Faye::WebSocket::Client.new("wss://api.coin.z.com/ws/public/v1")
ws.on :open do |event|
message = {
:command => "subscribe",
:channel => "trades",
:symbol => 'BTC'
}
ws.send(message.to_json)
end
ws.on :message do |event|
puts event.data
end
}