<p class='bg-yellow-500/10 border border-solid border-yellow-500/30 border-l-4 border-l-yellow-500/60 rounded-lg p-6'>We are working on this doc page and will be available soon 🙌. Until then, we hope the <a href='/docs/getting-started/quickstart'>quick start guide</a> explains everything you need to know about PUBQ and interact with.</p>

This page lists the available REST APIs over HTTP.

REST HTTP API Reference

This is the home page of the PUBQ documentation

Docs Home

What is PUBQ?

How to use PUBQ?

Provides guidelines for contributing to the PUBQ Open Source.

Contribution Guide

This section covers the basics of the PUBQ.

Basics

Offers a quick guide to get started with the PUBQ.

Quick Start Guide

Available SDKs

Available APIs

Getting Started

Provides an overview of the authentication process.

Overview

Explains how to use basic authentication with PUBQ.

Basic auth

Explains how to use token authentication with PUBQ.

Token auth

Explains how to allocate a client ID to identify the client.

Identified clients

Explains how to use capabilities in authentication with PUBQ.

Capabilities

Authentication

Describes the different states of a connection.

Connection State

Covers establishing and managing connections.

Connection

Provides an overview of publish/subscribe channels.

Subscribe

Explains how to publish messages to channels.

Publish

Covers the usage of publish/subscribe channels.

Pub/Sub Channels

Provides overview of references for the PUBQ SDKs and APIs.

Explains the available real-time SDK methods, options and properties.

Realtime SDK

Lists the available REST SDK methods and options.

REST SDK

Explains the available real-time APIs over WebSocket.