Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Quix Streaming Reader API (Real-time)

Subscribe to live parameter data, events, definitions, active streams, topic metrics, and raw packages from Quix topics in real time over a Microsoft SignalR hub (WebSockets, with Long Polling fallback). Authenticated with a PAT via accessTokenFactory.

Quix Streaming Reader API (Real-time) is one of 9 APIs that Quix publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Streaming, Reader, Real Time, SignalR, and WebSocket. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

This event API exposes 10 operations across 5 channels, and defines 18 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.

The API connects through a single server, reader-{environmentId}.cloud.quix.io/hub (wss).

10 operations 5 channels 18 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0.0
Base URL
https://reader-{environmentId}.cloud.quix.io/hub
Resource Areas
1

Channels & Operations 10

Across 5 channels, the API surfaces 10 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 10
SUB
ParameterData
Receive pushed parameter data (ParameterDataReceived).
onParameterDataReceived body
PUB
ParameterData
Invoke hub method to subscribe to parameter data.
subscribeToParameter body
SUB
EventData
Receive pushed event data (EventDataReceived).
onEventDataReceived body
PUB
EventData
Invoke hub method to subscribe to event data.
subscribeToEvent body
SUB
ActiveStreams
Receive active-stream change notifications (ActiveStreamsChanged).
onActiveStreamsChanged body
PUB
ActiveStreams
Invoke hub method to subscribe to active-stream changes.
subscribeToActiveStreams body
SUB
TopicMetrics
Receive topic metrics (TopicMetricsUpdated).
onTopicMetricsUpdated body
PUB
TopicMetrics
Invoke hub method to subscribe to topic metrics.
subscribeToTopicMetrics body
SUB
Packages
Receive raw packages (PackageReceived).
onPackageReceived body
PUB
Packages
Invoke hub method to subscribe to raw packages.
subscribeToPackages body

Messages & Schemas 18

The contract defines 18 schemas that model the data carried by its messages. The most detailed are ParameterData (7 properties), EventData (6 properties), Package (4 properties), TopicMetrics (3 properties). Each schema is shown below with its type and property counts.

SubscribeToParameter
message
Client-to-server SignalR invocation to subscribe to parameter data.
ParameterDataReceived
message
A batch of time-series parameter samples pushed by the hub.
SubscribeToEvent
message
Client-to-server SignalR invocation to subscribe to event data.
EventDataReceived
message
A discrete event pushed by the hub.
SubscribeToActiveStreams
message
Client-to-server SignalR invocation to subscribe to active-stream changes.
ActiveStreamsChanged
message
A stream was added/updated or removed on the topic.
SubscribeToTopicMetrics
message
Client-to-server SignalR invocation to subscribe to topic metrics.
TopicMetricsUpdated
message
Periodic topic metrics pushed by the hub.
SubscribeToPackages
message
Client-to-server SignalR invocation to subscribe to raw packages.
PackageReceived
message
A raw message received on the topic.
ParameterSubscriptionArgs
object
Positional SignalR arguments for SubscribeToParameter.
3 properties 3 required
EventSubscriptionArgs
object
Positional SignalR arguments for SubscribeToEvent.
3 properties 3 required
TopicArg
object
Positional SignalR argument carrying just the topic name.
1 property 1 required
ParameterData
object
A batch of time-series parameter samples.
7 properties
EventData
object
A single discrete event.
6 properties
ActiveStreamChange
object
Notification that a stream was added/updated or removed.
2 properties
TopicMetrics
object
Periodic metrics for a topic.
3 properties
Package
object
A raw message received on the topic.
4 properties

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

quix-asyncapi.yml Raw ↑

Other APIs Quix publishes across the network.

Quix Streams (Open Source)
Quix Definitions API
Quix Deployments API
Quix Event Data API
Quix Parameter Data API
Quix Streams API
Quix Topics API
Quix Workspaces API