WebSocket events (reference)

curl --request GET \
  --url https://api.skinshark.gg/ws/events \
  --header 'api-key: <api-key>'

{
  "event": "connected",
  "data": {
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "ts": 123
}

WebSocket

WebSocket events (reference)

This is a documentation-only path — there is no HTTP endpoint at /ws/events. Use it to navigate the message schemas pushed over /ws.

Discriminate on event:

connected → WsConnectedEvent
deposit.transfer → WsDepositTransferEvent (gatepay on-chain detected)
deposit.completed → WsGatewayDepositCompletedEvent or WsCryptoDepositCreditedEvent (distinguish by data.fundingId vs data.depositId)
deposit.failed → WsDepositFailedEvent or WsCryptoDepositFailedEvent (distinguish by data.fundingId vs data.depositId)
deposit.refunded → WsDepositRefundedEvent
deposit.pending → WsCryptoDepositPendingEvent
trade.<status> → WsTradeUpdateEvent
system.notice → WsSystemNoticeEvent

GET

events

WebSocket events (reference)

curl --request GET \
  --url https://api.skinshark.gg/ws/events \
  --header 'api-key: <api-key>'

{
  "event": "connected",
  "data": {
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "ts": 123
}

Authorizations

api-key

string

header

required

Your raw API key. Generate, rotate, and revoke keys from the merchant dashboard. Keys can optionally be bound to one or more allowed source IPs — requests from any other IP are rejected with API_KEY_IP_DENIED.

Response

(reference only)

Discriminated union of every server-pushed frame on /ws.

event

enum<string>

required

Available options:

connected

data

object

required

Show child attributes

integer

required

Unix epoch milliseconds.

Open WebSocket connection Open live-market WebSocket