Real-time Test Stream

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

const options = {method: 'GET', headers: {'Xerobi-Version': '<xerobi-version>'}};

fetch('https://api.hixbe.com/speedtest/stream', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hixbe.com/speedtest/stream",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Xerobi-Version: <xerobi-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hixbe.com/speedtest/stream"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Xerobi-Version", "<xerobi-version>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hixbe.com/speedtest/stream")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Xerobi-Version"] = '<xerobi-version>'

response = http.request(request)
puts response.read_body

event: ping
data: {"status":"starting","progress":10}

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: { 'Xerobi-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 --request GET \
  --url https://api.hixbe.com/speedtest/stream \
  --header 'Xerobi-Version: <xerobi-version>'

const options = {method: 'GET', headers: {'Xerobi-Version': '<xerobi-version>'}};

fetch('https://api.hixbe.com/speedtest/stream', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hixbe.com/speedtest/stream",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Xerobi-Version: <xerobi-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hixbe.com/speedtest/stream"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Xerobi-Version", "<xerobi-version>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hixbe.com/speedtest/stream")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Xerobi-Version"] = '<xerobi-version>'

response = http.request(request)
puts response.read_body

event: ping
data: {"status":"starting","progress":10}

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

Headers

Xerobi-Version

string

required

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

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

Example:

"2.0.0"

Response

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

Network API

Consumer

Business

RPKI

Route Validation

Status & Monitoring

Delta Updates

Speed Test API

Real-time Stream

Headers

Response