# List of patterns for Subscribe messages
If you do not need to specify any parameters, send ".*". For example:
// to subscribe to all deposits send a message like
{
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/deposit/.*"
}
//to subscribe to all BTC withdrawal send a message like
{
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/withdrawal.symbols/.*/BTC"
}
# Balances
# Deposit
The message update has the following event format.
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/deposit/<account`s wallet address>/<address of deposit token>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/deposit/<account`s wallet address>/<address of deposit token>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/deposit/<account`s wallet address>/<address of deposit token>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
Deposit by token symbol
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/deposit.symbols/<account`s wallet address>/<token symbol>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/deposit.symbols/<account`s wallet address>/<token symbol>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/deposit.symbols/<account`s wallet address>/<token symbol>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
# Withdrawal
The message update has the following event format.
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/withdrawal/<account`s wallet address>/<address of withdrawal token>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/withdrawal/<account`s wallet address>/<address of withdrawal token>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/withdrawal/<account`s wallet address>/<address of withdrawal token>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
Withdrawal by token symbol
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/withdrawal.symbols/<account`s wallet address>/<token symbol>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/withdrawal.symbols/<account`s wallet address>/<token symbol>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/withdrawal.symbols/<account`s wallet address>/<token symbol>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
# Orders
The message update has the following event format.
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/order/<account`s wallet address>/<base token address>/<quote token address>/<fee token address>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/order/<account`s wallet address>/<base token address>/<quote token address>/<fee token address>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/order/<account`s wallet address>/<base token address>/<quote token address>/<fee token address>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
Order by token symbol
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/order.symbols/<account`s wallet address>/<base token symbol>/<quote token symbol>/<fee token symbol>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/order.symbols/<account`s wallet address>/<base token symbol>/<quote token symbol>/<fee token symbol>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/order.symbols/<account`s wallet address>/<base token symbol>/<quote token symbol>/<fee token symbol>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
# Update
The message update has the following event format.
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/order-update/<account`s wallet address>/<base token address>/<quote token address>/<fee token address>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/order-update/<account`s wallet address>/<base token address>/<quote token address>/<fee token address>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/order-update/<account`s wallet address>/<base token address>/<quote token address>/<fee token address>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
By token symbol
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/order-update.symbols/<account`s wallet address>/<base token symbol>/<quote token symbol>/<fee token symbol>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/order-update.symbols/<account`s wallet address>/<base token symbol>/<quote token symbol>/<fee token symbol>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/order-update.symbols/<account`s wallet address>/<base token symbol>/<quote token symbol>/<fee token symbol>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
# Expired
The message update has the following event format.
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/order-expired/<account`s wallet address>/<base token address>/<quote token address>/<fee token address>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/order-expired/<account`s wallet address>/<base token address>/<quote token address>/<fee token address>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/order-expired/<account`s wallet address>/<base token address>/<quote token address>/<fee token address>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
By token symbol
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/order-expired.symbols/<account`s wallet address>/<base token symbol>/<quote token symbol>/<fee token symbol>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/order-expired.symbols/<account`s wallet address>/<base token symbol>/<quote token symbol>/<fee token symbol>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/order-expired.symbols/<account`s wallet address>/<base token symbol>/<quote token symbol>/<fee token symbol>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
# Filling
The message update has the following event format.
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/filling/<from which address>/<to which address>/<token address>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/filling/<from which address>/<to which address>/<token address>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/filling/<from which address>/<to which address>/<token address>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
By token symbol
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/filling.symbols/<from which address>/<to which address>/<token symbol>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/filling.symbols/<from which address>/<to which address>/<token symbol>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/filling.symbols/<from which address>/<to which address>/<token symbol>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
# Market
The message update has the following event format.
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/market-order/<account`s wallet address>/<base token address>/<quote token address>/<fee token address>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/market-order/<account`s wallet address>/<base token address>/<quote token address>/<fee token address>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/market-order/<account`s wallet address>/<base token address>/<quote token address>/<fee token address>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
By token symbol
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/market-order.symbols/<account`s wallet address>/<base token symbol>/<quote token symbol>/<fee token symbol>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/market-order.symbols/<account`s wallet address>/<base token symbol>/<quote token symbol>/<fee token symbol>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/market-order.symbols/<account`s wallet address>/<base token symbol>/<quote token symbol>/<fee token symbol>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
# Trade
The message update has the following event format.
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/trade/<base token address>/<quote token address>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/trade/<base token address>/<quote token address>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/trade/<base token address>/<quote token address>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
By token symbol
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/trade.symbols/<base token symbol>/<quote token symbol>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/trade.symbols/<base token symbol>/<quote token symbol>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/trade.symbols/<base token symbol>/<quote token symbol>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
By maker address or taker address
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/trade.accounts/<maker address or taker address>/<base token address>/<quote token address>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/trade.accounts/<maker address or taker address>/<base token address>/<quote token address>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/trade.accounts/<maker address or taker address>/<base token address>/<quote token address>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
# Ticker
Available values for period: I1, I5, I15, I30, H1, H2, H4, H6, H12, D1, W1
- I - minutes
- H - hours
- D - days
- W - week
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/ticker/<market>/<period>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/ticker/<market>/<period>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/ticker/<market>/<period>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
# Order book
The message update has the following event format.
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/orderbook/<market>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/orderbook/<market>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/orderbook/<market>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
Raw
The message update has the following event format.
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/orderbook.raw/<market>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/orderbook.raw/<market>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/orderbook.raw/<market>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}
Group
The message update has the following event format.
const wss = new WebSocket('wss://plasma-relay-backend.timex.io/socket/relay')
let msg = JSON.stringify({
type: "SUBSCRIBE",
requestId: "uniqueID",
pattern: "/orderbook.group/<market>"
})
wss.onopen = () => wss.send(msg)
wss.onmessage = (msg) => console.log(msg.data)
wss.onerror = (error) => console.error(error.message)
import websocket
import json
def on_message(ws, message):
print(message)
def on_open(ws):
msg = {
"type": "SUBSCRIBE",
"requestId": "uniqueID",
"pattern": "/orderbook.group/<market>"
}
ws.send(json.dumps(msg))
def on_error(ws, error):
print(error)
ws = websocket.WebSocketApp("wss://plasma-relay-backend.timex.io/socket/relay",
on_message=on_message,
on_error=on_error)
ws.on_open = on_open
ws.run_forever()
include __DIR__ . '/vendor/autoload.php';
use WebSocket\Client;
$sslOptions = [];
$client = new Client('wss://plasma-relay-backend.timex.io/socket/relay', [
'timeout' => 30,
'context' => stream_context_create($sslOptions)
]);
$msg = [
"type" => "SUBSCRIBE",
"requestId" => "uniqueID",
"pattern" => "/orderbook.group/<market>"
];
$client->send(json_encode($msg));
while ($response = $client->receive()) {
echo $response. "\n";
}