Nakama Realtime Socket API
Persistent WebSocket connection carrying realtime features - status presence, realtime chat channels, relayed and authoritative multiplayer matches, matchmaking, parties, and realtime notification delivery - as envelope messages authenticated with a session token supplied as a query parameter on connect.
Nakama Realtime Socket API is one of 11 APIs that Nakama publishes on the APIs.io network, described by an AsyncAPI event-driven specification.
Tagged areas include Realtime, WebSocket, Multiplayer, Matchmaking, and Chat. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.
This event API exposes 2 operations across 1 channel, and defines 31 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.
The API connects through a single server, 127.0.0.1:7350 (ws).
Metadata
The identity and technical contract details declared by the specification.
Channels & Operations 2
Across 1 channel, the API surfaces 2 operations. Each is listed below with its action, channel, parameters, and response codes.
Messages & Schemas 31
The contract defines 31 schemas that model the data carried by its messages. The most detailed are Presence (5 properties), EnvelopeMatch (2 properties), EnvelopeChannel (2 properties), EnvelopeStatusUpdate (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable AsyncAPI contract behind this narrative.
Source
More from Nakama 10
Other APIs Nakama publishes across the network.