WebSocket API

API
There are two types of channels: * Public: accessible by anyone * Private: accessible only by given member
GET request parameters:
Field
Description
Multiple allowed
stream
List of streams to be subscribed on
Yes
List of supported public streams: * <market>.ob-inc market order-book update * <market>.trades * <market>.kline-PERIOD (available periods are "1m", "5m", "15m", "30m", "1h", "2h", "4h", "6h", "12h", "1d", "3d", "1w") * global.tickers
List of supported private streams (requires authentication): * order * trade
You can find a format of these events below in the doc.
​
Authentication
JS Example
const CryptoJS = require("crypto-js");
var WebSocketClient = require('websocket').client
​
var client = new WebSocketClient();
client.on('connectFailed', function (error) {
  console.log('Connect Error: ' + error.toString());
});
​
client.on('connect', function (connection) {
  console.log('WebSocket Client Connected');
  connection.on('error', function (error) {
    console.log("Connection Error: " + error.toString());
  });
  connection.on('close', function () {
    console.log('echo-protocol Connection Closed');
  });
  connection.on('message', function (message) {
    if (message.type === 'utf8') {
      console.log("Received: '" + message.utf8Data + "'");
    }
  });
});
​
let nonce = 0;
const d = new Date();
const timestamp = d.getTime();
nonce = timestamp;
const apiKey = "8df7dxxxx"
const secret = "177e099e5e04xxxx";
const h = CryptoJS.HmacSHA256(nonce +apiKey, secret).toString(CryptoJS.digest);
​
const headers = {};
headers['X-Auth-Apikey'] = '8df7d07e2fxxxx';
headers['X-Auth-Nonce'] = nonce;
headers['X-Auth-Signature'] = h;
​
client.connect('wss://trade.nebulaecn.com/api/v2/strean/private/ \
?stream=balances&stream=order&stream=trade', null, null, headers);
​
​
‌1.Use API Key for the private WebSockets connection. Example:
curl -H "X-Auth-Apikey:8df7d07e2fxxxx" \
-H "X-Auth-Nonce:1632499941797" \
-H "X-Auth-Signature:96855ae3985bc3b0da3429ea4bada6985b30e181e49dd4beccdxxx"
 -H "Connection: Upgrade"  -H "Upgrade: websocket"  -H "Host: trade.nebulaecn.com" \
 -H "Origin: https://trade.nebulaecn.com" -i -N \
 wss://trade.nebulaecn.com/api/v2/stream/private/?stream=balances \ 
 &stream=deposit_address&stream=order&stream=trade
3.If authentication was done, server will respond successfully.
{
  "success": {
    "message": "subscribed",
    "streams": [
                "balances","order","trade"
                ]
    }
}
Otherwise server will return an error: 
Status Code: 401 Unauthorized
If other error occurred during the message handling server throws an error:
{
  "error": {
    "message": "Error while handling message."
  }
}
​
Streams subscription
Using parameters
You can specify streams to subscribe to by passing the stream GET parameter in the connection URL. The parameter can be specified multiple times for subscribing to multiple streams.
example:
wss://trade.nebulaecn.com/api/v2/stream/public/?stream=global.tickers&stream=ethusd.trades
This will subscribe you to tickers and trades events from ethusd market once the connection is established.
Subscribe and unsubscribe events
You can manage the connection subscriptions by send the following events after the connection is established:
Subscribe event will subscribe you to the list of streams provided:
{"event":"subscribe","streams":["ethusd.trades","ethusd.ob-inc"]}
The server confirms the subscription with the following message and provides the new list of your current subscriptions:
{"success":{"message":"subscribed","streams":["global.tickers","ethusd.trades","ethusd.ob-inc"]}}
Unsubscribe event will unsubscribe you to the list of streams provided:
{"event":"unsubscribe","streams":["ethusd.trades","ethusd.ob-inc"]}
The server confirms the unsubscription with the following message and provides the new list of your current subscriptions:
{"success":{"message":"unsubscribed","streams":["global.tickers","ethusd.kline-15m"]}}
Public streams
Order-Book
This stream sends a snapshot of the order-book at the subscription time, then it sends increments. Volumes information in increments replace the previous values. If the volume is zero the price point should be removed from the order-book.
Register to stream <market>.ob-inc to receive snapshot and increments messages.
Example of order-book snapshot:
{
    "eurusd.ob-snap":{
        "asks":[
            ["15.0","21.7068"],
            ["20.0","100.2068"],
            ["20.5","30.2068"],
            ["30.0","21.2068"]
        ],
        "bids":[
            ["10.95","21.7068"],
            ["10.90","65.2068"],
            ["10.85","55.2068"],
            ["10.70","30.2068"]
        ]
    }
}
Example of order-book increment message:
 {
     "eurusd.ob-inc":{
         "asks":[
             ["15.0","22.1257"]
         ]
     }
 }
Trades
Here is structure of <market>.trades event expose as array with trades:
Field
Description
tid
Unique trade tid.
taker_type
Taker type of trade, either buy or sell.
price
Price for the trade.
amount
The amount of trade.
created_at
Trade create time.
Kline point
Kline point as array of numbers:
1.Timestamp.
2.Open price.
3.Max price.
4.Min price.
5.Last price.
6.Period volume
Example:
[1537370580, 0.0839, 0.0921, 0.0781, 0.0845, 0.5895]
Tickers
Here is structure of global.tickers event expose as array with all markets pairs:
Field
Description
at
Date of current ticker.
name
Market pair name.
base_unit
Base currency.
quote_unit
Quote currency.
low
Lowest price in 24 hours.
high
Highest price in 24 hours.
last
Last trade price.
open
Last trade from last timestamp.
close
Last trade price.
volume
Volume in 24 hours.
sell
Best price per unit.
buy
Best price per unit.
avg_price
Average price for last 24 hours.
price_change_percent
Average price change in percent.
Private streams
Order
Here is structure of Order event:
Field
Description
id
Unique order id.
market
The market in which the order is placed. (In backend market_id)
order_type
Order type, either limit or market.
price
Order price.
avg_price
Order average price.
state
One of wait, done, reject or cancel.
origin_volume
The amount user want to sell/buy.
remaining_volume
Remaining amount user want to sell/buy.
executed_volume
Executed amount for current order.
created_at
Order create time.
updated_at
Order create time.
trades_count
Trades with this order.
kind
Type of order, either bid or ask. (Deprecated)
at
Order create time. (Deprecated) (In backendcreated_at)
Trade
Here is structure of Trade event:
Field
Description
id
Unique trade identifier.
price
Price for each unit.
amount
The amount of trade.
total
The total of trade (volume * price).
market
The market in which the trade is placed. (In backend market_id)
side
Type of order in trade that related to current user sell or buy.
taker_type
Order side of the taker for the trade, either buy or sell.
created_at
Trade create time.
order_id
User order identifier in trade.
Subscribe to streams
Websocket API is located at https://nebulaecn.com/api/v2/trading. If you pass a JWT header, your connection will be authenticated, otherwise it will be considered anonymous.
Example
[1, 2, "subscribe", ["private", ["order", "trade", "balances"]]]
Get your open orders
[1, 2, "list_orders", ["btcusd"]]
[
  2,
  2,
  "list_orders",
  [
    [
      "btcusd",
      97,
      "6dcc2c8e-c295-11ea-b7ad-1831bf9834b0",
      "sell",
      "w",
      "l",
      "9120",
      "0",
      "0.25",
      "0.25",
      "0",
      0,
      1594386563
    ]
  ]
]
Order response schema
Field
Example
Market
"btcusd"
ID
97
UUID
"6dcc2c8e-c295-11ea-b7ad-1831bf9834b0"
Side
"sell"
State
"w"
Type
"l"
Price
"9120"
Avg. Price
"0"
Volume
"0.25"
Orig. Volume
"0.25"
Executed Volume
"0"
Trades Count
0
Timestamp
1594386563
Get order by uuids
[
  1,
  3,
  "get_orders",
  [
    "6dcc2c8e-c295-11ea-b7ad-1831bf9834b0",
    "4fec493d-c2a2-11ea-b670-1831bf9834b0"
  ]
]
[
  2,
  3,
  "get_orders",
  [
    [
      "btcusd",
      97,
      "6dcc2c8e-c295-11ea-b7ad-1831bf9834b0",
      "sell",
      "w",
      "l",
      "9120",
      "0",
      "0.25",
      "0.25",
      "0",
      0,
      1594386563
    ],
    [
      "btcusd",
      98,
      "4fec493d-c2a2-11ea-b670-1831bf9834b0",
      "sell",
      "c",
      "m",
      "0",
      "0",
      "0.25",
      "0.25",
      "0",
      0,
      1594392096
    ]
  ]
]
Get order trades
[1, 42, "get_order_trades", ["ab224fef-c2a2-11ea-b670-1831bf9834b0"]]
[
  2,
  42,
  "get_order_trades",
  [
    [
      "btcusd",
      33,
      "9120",
      "0.25",
      "2280",
      100,
      "ab224fef-c2a2-11ea-b670-1831bf9834b0",
      "buy",
      "buy",
      "0.0005",
      "btc",
      1594392250
    ]
  ]
]
Trade response schema
Field
Example
Market
"btcusd"
ID
33
Price
"9120"
Amount
"0.25"
Total
"2280"
OrderID
100
OrderUUID
"ab224fef-c2a2-11ea-b670-1831bf9834b0"
OrderSide
"buy"
TakerSide
"buy"
Fee
"0.0005"
Fee Unit
"btc"
Timestamp
1594392250
Create order
Arguments:
Arg
Comment
Market
​
Type
M is Market L is Limit P is PostOnly
Side
buy or sell
amount
sting, int, float
price
ignored for market order
Responds with ok and uuid of new order if order is pushed to engine. Response with error and short description in case of failure.
Example
[1, 42, "create_order", ["btcusd", "m", "sell", "0.250000", "9120.00"]]
Response
[2, 42, "create_order", ["4fec493d-c2a2-11ea-b670-1831bf9834b0"]]
Cancel order
Arguments:
Arg
Desc
Mode
id, uuid, market, all(any market)
ID
ID, UUID or market ID respectively
NOTE: cancels multiple orders for "market" and "all"
Example
[1, 42, "cancel_order", ["market", "btcusd"]]
Response
[2, 42, "cancel_order", null]
Bulk order create
Arguments: array or Create order params
Responds with array of:
uuid for crated order
"error" if some error ocurred
Example
[
  1,
  42,
  "create_bulk",
  [
    ["btcusd", "l", "buy", "0.250000", "9120.00"],
    ["btcusd", "l", "sell", "0.250000", "9120.00"]
  ]
]
Response
[
  2,
  42,
  "create_bulk",
  [
    "04852bd8-c2a3-11ea-b670-1831bf9834b0",
    "04855535-c2a3-11ea-b670-1831bf9834b0"
  ]
]
Bulk order cancel
Arguments:
Arg
Desc
Mode
id or uuid
[ID]
List of IDs or UUIDs respectively
Echoes argument or puts error for argument which could not be parsed.
Example
[1, 42, "cancel_bulk", ["id", [12, "13", "abv"]]]
Response
[2, 42, "cancel_bulk", [12, 13, "error"]]

Models

Guides

Last modified 1yr ago

Field	Description
`id`	Unique order id.
`market`	The market in which the order is placed. (In backend `market_id`)
`order_type`	Order type, either `limit` or `market`.
`price`	Order price.
`avg_price`	Order average price.
`state`	One of `wait`, `done`, `reject` or `cancel`.
`origin_volume`	The amount user want to sell/buy.
`remaining_volume`	Remaining amount user want to sell/buy.
`executed_volume`	Executed amount for current order.
`created_at`	Order create time.
`updated_at`	Order create time.
`trades_count`	Trades with this order.
`kind`	Type of order, either `bid` or `ask`. (Deprecated)
`at`	Order create time. (Deprecated) (In backend`created_at`)

Field	Description
`id`	Unique trade identifier.
`price`	Price for each unit.
`amount`	The amount of trade.
`total`	The total of trade (volume * price).
`market`	The market in which the trade is placed. (In backend market_id)
`side`	Type of order in trade that related to current user `sell` or `buy`.
`taker_type`	Order side of the taker for the trade, either `buy` or `sell`.
`created_at`	Trade create time.
`order_id`	User order identifier in trade.

Field	Description	Multiple allowed
`stream`	List of streams to be subscribed on	Yes

Field	Description
`tid`	Unique trade tid.
`taker_type`	Taker type of trade, either `buy` or `sell`.
`price`	Price for the trade.
`amount`	The amount of trade.
`created_at`	Trade create time.

Field	Example
Market	"btcusd"
ID	97
UUID	"6dcc2c8e-c295-11ea-b7ad-1831bf9834b0"
Side	"sell"
State	"w"
Type	"l"
Price	"9120"
Avg. Price	"0"
Volume	"0.25"
Orig. Volume	"0.25"
Executed Volume	"0"
Trades Count	0
Timestamp	1594386563

Arg	Comment
Market
Type	M is Market L is Limit P is PostOnly
Side	buy or sell
amount	sting, int, float
price	ignored for market order

Arg	Desc
Mode	id, uuid, market, all(any market)
ID	ID, UUID or market ID respectively

WebSocket API

API

​

Authentication

Streams subscription

Using parameters

Subscribe and unsubscribe events

Public streams

Order-Book

Trades

Tickers

Private streams

Order

Trade

Subscribe to streams

Get your open orders

Order response schema

Get order by uuids

Get order trades

Trade response schema

Create order

Cancel order

Bulk order create

Bulk order cancel