Skip to main content
GET
/
websocket
WebSocket Connection Information
curl --request GET \
  --url https://api.royalti.io/websocket \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/websocket"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/websocket', 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.royalti.io/websocket",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.royalti.io/websocket"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.royalti.io/websocket")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/websocket")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

​
Description

​
Connecting to WebSocket

import { io } from 'socket.io-client';

const socket = io('https://api.royalti.io', {
  auth: { token: accessToken },
  path: '/socket.io'
});

// Listen for file processing events
socket.on('file:processing:started', (data) => {
  console.log('Processing started:', data.fileId);
});

socket.on('file:processing:progress', (data) => {
  console.log(`Progress: ${data.progress}% - ${data.message}`);
});

socket.on('file:processing:completed', (data) => {
  console.log('Processing complete:', data.fileId);
});

socket.on('file:processing:failed', (data) => {
  console.error('Processing failed:', data.error);
});

​
Code Examples

const response = await fetch('https://api.royalti.io/websocket', {
  method: 'GET',
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
  'https://api.royalti.io/websocket',
)

data = response.json()
print(data)

curl -X GET https://api.royalti.io/websocket \

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Response

101

WebSocket upgrade (not a REST endpoint)