headers?

[RegEM]

Hi James,
Just wondering if there is a way to enter headers with the current module?
I see it connected to my api (created a job), without my nonce and key. Would that be a problem on their end?
Thanks, Richard

[StartAutomating]

Looks like this would be possible with an additional property.

https://learn.microsoft.com/en-us/dotnet/api/system.net.websockets.clientwebsocket.httpresponseheaders?view=net-9.0#system-net-websockets-clientwebsocket-httpresponseheaders

Can you give me some idea what you'd like to pass / of a server that would need them?

( I'm always looking for other services that support sockets )

[RegEM]

The documentation is below. They have a Rest-Api, for their exchange as well.
I've only just started with it, and know I need to spruce up my PS. I'm watching your 3hr modules video soon. Looks interesting.

It's not explicitly stated, but I tried wss://client-api.kinesis.money/v1/sockets/exchange/depth?symbolIds=KAUKAG" and it seemed to connect. The Job was running.

The socket channels are meant to be used for real-time tracking of the exchange prices.

In order to authenticate the connection, headers should be provided:

Authentication
X-API-Key Your public API key.

X-Nonce A UNIX timestamp in milliseconds after which the request is no longer valid.

X-Signature It is calculated as follows:
HEX(HMAC_SHA256(apiSecret, str(nonce) + GET + path)).

Depth update socket
Description
A websocket which pushes new events whenever the depth changes for one of the selected currency pairs (listed in the symbolIds when subscribing).

Path
/v1/sockets/exchange/depth?symbolIds={{comma delimited list of currency pair IDs}}
OnInit- Publish upon a new connection, contains a snapshot of the current depth for the currency pairs.

Websocket Event
onInit
Parameter
Data Type
Description
symbolId	String	The currency pair identifier
direction	String	Is it the bid or ask side of the depth
depth	String	A container for all the aggregated order view on the buy sell
amount	String	The amount of units being sold or bought
price	String	The price the units are being sold or bought
Sample Payload
[{
    "symbolId": "KAU_USD",
    "bid": [{
      "amount": 5,
      "price": 59
    }, {
      "amount": 8,
      "price": 58
    }],
    "ask": [{
      "amount": 5,
      "price": 60
    }, {
      "amount": 6,
      "price": 61
    }]
}, {
  "symbolId": "KAG_USD",
  "bid": [{
    "amount": 5,
    "price": 21
  }, {
    "amount": 8,
    "price": 20
  }],
  "ask": [{
    "amount": 5,
    "price": 21.50
  }, {
    "amount": 6,
    "price": 22
  }]
}, ... //Identical events for any other currencyPairs included in the currencyPairId query params on subscription]
OnChange- Emitted every time the depth changes on one side of the order book for a given currency pair

Websocket Event
onChange
Sample Payload
{
    "symbolId": "KAU_USD",
    "direction": "bid",
    "depth": {
      "bid": [{
        "amount": 5,
        "price": 59
      }, {
        "amount": 8,
        "price": 58
      }],
      "ask": [{
        "amount": 5,
        "price": 60
      }, {
        "amount": 6,
        "price": 61
      }]
    }
}
Exchange Mid Price socket
Description
A websocket which pushes new events whenever the mid price changes for one of the selected currency pairs (listed in the symbolIds when subscribing).

Path
/v1/sockets/exchange/mid-price?symbolIds={{comma delimited list of currency pair IDs}}
OnInit- Publish upon a new connection, contains a snapshot of the current mid prices for the currency pairs.

Websocket Event
onInit
Parameter
Data Type
Description
symbolId	String	The currency pair identifier
symbolPrice	String	The exchange mid price.
Sample Payload
[{
    "symbolId": "KAU_USD",
    "symbolPrice": 59.30
}, {
  "symbolId": "KAG_USD",
  "symbolPrice": 21.30
}, ... //Identical events for any other currencyPairs included in the currencyPairId query params on subscription]
OnChange- Emitted every time the depth changes on one side of the order book for a given currency pair

Websocket Event
onChange
Sample Payload
{
    "symbolId": "KAU_USD",
    "latestMidPrice": 59.42
}
Exchange Snapshot socket
Description
A websocket which pushes new events whenever the bid/ask price changes or whenever a trade is executed

Path
/v1/sockets/exchange/snapshots
OnInit- Published upon a new connection, contains a snapshot of the prices and volumes for each currency pair

Websocket Event
onInit
Parameter
Data Type
Description
symbolId	String	The currency pair identifier
latestMidPrice	Double	The latest mid price for the currency pair
dailyChange	Double	The percentage in change between the mid price at the start of the day and the latest mid price
dailyVolume	Double	The daily trade volume of the quote currency
timeFrameVolume	Object	The trade volume of the quote currency for the each time frame period
bidPrice	Double	The highest bid price
askPrice	Double	The lowest ask price
Sample Payload
[
    {
      "symbolId": "KAU_USD",
      "latestMidPrice": 22,
      "dailyChange": 31,
      "dailyVolume": 344,
      "timeFrameVolume": {
        "5": 12.4,
        "15": 12.4,
        "60": 55.55,
        "240": 150.1,
        "1440": 150.1
      },
      "bidPrice": 62.4,
      "askPrice": 63.1
    },
    ...
  ]
OnChange- Emitted every time a trade is executed or the depth changes on either side of the order book for a given currency pair

Websocket Event
onChange
Sample Payload
{
    "symbolId": "KAG_EUR",
    "latestMidPrice": 10.1,
    "dailyChange": 10.2,
    "dailyVolume": 22,
    "timeFrameVolume": {
      "5": 0,
      "15": 0,
      "60": 0,
      "240": 0,
      "1440": 10.2
    },
    "bidPrice": 11.2,
    "askPrice": 12.1
  },`

[RegEM]

Though I guess it would run if I connected to https: instead. With the https. it shows HasMoreData true, but False with the wss:.

[RegEM]

Not a surprise, as I am not providing the nonce and my key. I'm just practicing how to enter code in my comments, and learning your ws command parameters.

WebSocket -WebSocketUri "wss://client-api.kinesis.money/v1/sockets/exchange/depth?symbolIds=KAU_KAG" -RawText

`Id     Name            PSJobTypeName   State         HasMoreData     Location             Command
--     ----            -------------   -----         -----------     --------             -------
5      wss://client-a… ThreadJob       Running       False           PowerShell           …`

[StartAutomating]

All very interesting!

My brief research looks like you might need to do a handshake message ( working on that capability ).

The headers should be possible to pass into this scenario, according to .net docs. If that doesn't work, there might be a web socket upgrade endpoint that will handle the authorization.

Kindly link to these api docs, if they are public.

[RegEM]

Thanks for your interest & efforts James.

Unfortunately the Api docs are not on a public link, though the example Rest code (python & php) are on github. https://github.com/bullioncapital/kinesis-api

I can post the rest-api doc, though it will be long. Please let me know if you will like that? The entirety of the websocket connection is above.

I removed the code I was sharing. It was for the rest-api, not the socket-api

[RegEM]

I believe there is a method for setting the headers. https://learn.microsoft.com/en-us/dotnet/api/system.net.websockets.clientwebsocketoptions.setrequestheader?view=net-9.0

I believe there are issues when using it from a browser, but we're not doing that. And perhaps other issues if the header is already set, or is protected.

I'll add, that this project does it like this in c#, https://github.com/nats-io/nats.net/blob/af04c71b2316eafb1e714ef961aa76f04dfd1a4d/src/NATS.Client.Core/NatsWebSocketOpts.cs#L13

[RegEM]

No doubt it could be done in c# (there are some libraries floating around), so likely could be done in powershell too.

However, I see this info on the socket.io site.

"Although Socket.IO indeed uses WebSocket for transport when possible, it adds additional metadata to each packet. That is why a WebSocket client will not be able to successfully connect to a Socket.IO server, and a Socket.IO client will not be able to connect to a plain WebSocket server either."

I was experimenting with it on node, and I believe it was not possible to get a ws: or wss: request on my Windows pc, as they do not have the require code support for windows.

I'll go ahead and close this. Thanks again for your interest.