Exchange Events #
Exchange Configuration Events #
Exchange Configuration Activation #
Sends a notification when a new exchange configuration is activated.
Permissions: exchange-configs-read
Payload:
{
"id": "9bsv0s78ajk0036f3m60",
"created_at": "2020-09-10T21:01:20Z",
"updated_at": "2020-09-10T21:01:20Z",
"used_at": "2020-10-10T20:01:20Z",
"name": "exchange1"
}
Exchange configuration properties are described in detail
here.
Note that the scheme property is omitted from the returned exchange
configuration object.
Live Exchange Data Events #
Live Exchange Ticker Update #
[email protected].{symbol}
Sends a notification when a specific symbol’s ticker data is updated.
Permissions: exchange-live-data-read
Payload:
{
"last": "31211.45",
"ask": "32211.45",
"bid": "30211.45",
"change": "1201.12",
"percent_change": "7",
"volume": "31234512.1"
}
Live exchange ticker properties are described in detail here.
A subscription request can be sent even if there is no active exchange configuration, however, events are sent only when one is present.
Live Exchange Candle Update #
[email protected].{symbol}.{interval}
Sends a notification when a specific symbol and interval’s candle data is updated.
Permissions: exchange-live-data-read
Payload:
{
"opened_at": "2020-09-10T21:01:20Z",
"open": "2",
"high": "3",
"low": "4",
"close": "5",
"volume": "6"
}
Live exchange candle properties are described in detail here. Note that candle events update only the latest candle.
A subscription request can be sent even if there is no active exchange configuration, however, events are sent only when one is present.
Live Exchange Account Information Update #
Sends a notification when account information is updated.
Permissions: exchange-live-data-read
Payload:
{
"cash": {
"asset": "USD",
"quantity": "31.0"
}
}
Live exchange account information properties are described in detail here.
A subscription request can be sent even if there is no active exchange configuration, however, events are sent only when one is present.
Live Exchange Positions Update #
Sends a notification when account positions are updated.
Permissions: exchange-live-data-read
Payload:
{
"BTC": {
"quantity": "0.31"
},
"ETH": {
"quantity": "1203.12"
}
}
Live exchange position properties are described in detail here. Note that only new or updated positions are included in the payload.
A subscription request can be sent even if there is no active exchange configuration, however, events are sent only when one is present.
Exchange Order Events #
Exchange Order Update #
Sends a notification when an order is updated (placed/accepted/closed).
Permissions: exchange-orders-read
Payload:
{
"id": "9bsv0s78ajk0036f3m60",
"identity": {
"id": "12sv0s78ajk0036f3m60",
"created_at": "2020-09-10T21:01:20Z",
"type": "binance",
"codename": "exchange-code-name"
},
"external_id": "78ajk0036f3m60",
"symbol": "BTC_USDT",
"side": "buy",
"price": "38012.123",
"total_quantity": "0.0541",
"filled_quantity": "0.0241",
"cancelled": true,
"manual": false,
"placed_at": "2020-09-10T21:01:20Z",
"accepted_at": "2020-09-10T21:01:20Z",
"closed_at": "2020-10-10T20:01:20Z"
}
Exchange order properties are described in detail here.