Real-time Stream

Server-Sent Events (SSE) endpoint that streams real-time progress updates during a full speed test.

Event Types:

• ping: Ping test starting/completed
• jitter: Jitter test completed
• download: Download test starting/completed
• upload: Upload test starting/completed
• finish: Test completed with all results
• error: Test failed with error details

Event Data:

• status: Test phase status (starting/completed)
• result: Test result value
• progress: Overall test progress (0-100%)

Implementation Example:

const eventSource = new EventSource(
  'https://api.hixbe.com/speedtest/stream',
  { headers: { 'Hixbe-Version': '2.0.0' } }
);

eventSource.addEventListener('ping', (e) => {
  const data = JSON.parse(e.data);
  console.log('Ping:', data.result, 'ms');
  updateProgress(data.progress);
});

eventSource.addEventListener('finish', (e) => {
  const data = JSON.parse(e.data);
  console.log('Complete:', data.result);
  eventSource.close();
});

eventSource.addEventListener('error', (e) => {
  console.error('Error:', e.data);
  eventSource.close();
});

Use Cases:

• Real-time UI updates
• Progress bars
• Live test monitoring
• Interactive dashboards

Note: Keep connection open until ‘finish’ or ‘error’ event received.

GET /stream

Real-time Test Stream

cURL

curl --request GET \
  --url https://api.hixbe.com/speedtest/stream \
  --header 'Hixbe-Version: <hixbe-version>'

200

pingStart

"event: ping\ndata: {\"status\":\"starting\",\"progress\":10}\n\n"

Server-Sent Events stream for real-time test progress monitoring and status updates.

Headers

Hixbe-Version · string · required

API version header. Required for all endpoints except / and /health

Pattern: ^\d+\.\d+\.\d+$

Example:

"2.0.0"

Response

200

text/event-stream

Stream connection established

Server-Sent Events stream with test progress

event · enum<string>

Available options: ping, jitter, download, upload, finish, error

data · string

JSON-encoded event data