Documentation / Guides

WebSocket stream PLANNED

Live changes pushed to you the moment they happen, instead of polling.

Planned, not built yet

This guide describes how it will work so you can plan around it. Nothing on this page can be called today.

  • Needs: the push service on the API host
  • For: Live and Complete

How it will work: open one connection and receive a message whenever a point, game or match changes at any table.

JavaScript
const ws = new WebSocket("wss://api.tabletennisapi.com/v1/stream?key=...");
ws.onmessage = (e) => draw(JSON.parse(e.data));

The key in the address above is a placeholder: the final design will pass it in a way that keeps it out of logs.

Ask about this