KirillBelov/WebSocketLink

(1.0.1) current version: 1.0.2 »

Web socket connection client

Contributed by: Kirill Belov

This package allows you to connect to remote servers that operate using the WS or WSS protocol. Once connected, you can send messages to the remote server and receive messages.

Installation Instructions

To install this paclet in your Wolfram Language environment, evaluate this code:
PacletInstall["KirillBelov/WebSocketLink"]

Examples

Basic Examples (7)

Import the package:

In[1]:=

Let's create a connection:

In[2]:=

Out[2]=

Let's see what came after a few seconds:

In[3]:=

Out[3]=

You can retrieve the latest received data:

In[4]:=

Out[4]=

Let's send a message and subscribe to another stream:

In[5]:=

Out[5]=

In[6]:=

Out[6]=

After that we will be able to receive data of another type:

In[7]:=

Short@
SelectFirst[#e == "depthUpdate" &]@
Select[KeyExistsQ[#, "e"] &]@
Map[ImportString[#, "RawJSON"] &] @ connection["Data"]["Elements"]

Out[7]=

Let's close the connection:

In[8]:=

Out[8]=

Scope (15)

Custom serializer (5)

By default you can send to the server frames as a string, but you can use custom serialiser for frames:

In[9]:=

Out[9]=

In[10]:=

$miniTickerSerialize[pair_String] := ExportString[<|"method" -> "SUBSCRIBE", "params" -> {pair <> "@miniTicker"}, "id" -> RandomInteger[{1, 1000}]|>, "RawJSON"]$

Use this serializer:

In[11]:=

Out[11]=

Extract data for ETHUSDT:

In[12]:=

Short[ethusdtTicker =
Query[All, {"E"/*(#/1000 &)/*FromUnixTime, "c"/*ToExpression}]@
Select[KeyExistsQ[#, "s"] && #[["s"]] == "ETHUSDT" &]@
Map[ImportString[#, "RawJSON"] &]@
connection["Data"]["Elements"]]

Out[12]=

And plot the price of the coin:

In[13]:=

Out[13]=

Close the connection:

In[14]:=

Out[14]=

Custom deserializer (4)

Also you can use custom deserializer:

In[15]:=

miniTickerDeserialize[miniTicker_String] :=
Query[<|"Time" -> "E"/*(#/1000 &)/*FromUnixTime, "Price" -> "c"/*ToExpression|>]@
ImportString[miniTicker, "RawJSON"]

In[16]:=

connection = WebSocketConnect[
"wss://stream.binance.com:9443/ws/btcusdt@miniTicker", "Deserializer" -> miniTickerDeserialize
]

Out[16]=

Now the saved data is immediately in the form of an expression and not a string:

In[17]:=

Plot it:

In[18]:=

Out[18]=

Close connection:

In[19]:=

Out[19]=

Event handler (6)

You can add custom event handler that will be process all received messages

First define a deserializer:

In[20]:=

$klineDeserialize[message_String] := Module[{k = ImportString[message, "RawJSON"]}, <| "s" -> k["s"], "t" -> FromUnixTime[k["k", "t"]/1000], "o" -> ToExpression[k["k", "o"]], "h" -> ToExpression[k["k", "h"]], "l" -> ToExpression[k["k", "l"]], "c" -> ToExpression[k["k", "c"]], "v" -> ToExpression[k["k", "v"]] |> ]$

Let's create a separate variable to store the results of processing:

In[21]:=

And the handler itself, which will not save unnecessary data on candles. After all, candles are completed once in a certain period, and the last candle is updated every few seconds:

In[22]:=

$klineEventHandler[connection_, kline_] := ( Print[kline]; If[! KeyExistsQ[klines, kline["s"]], klines[kline["s"]] = <||>]; klines[kline["s"], kline["t"] ] = {kline["t"], Values[kline[[{"o", "h", "l", "c", "v"}]]]} )$