Documentation
Pairiquium is the matchmaking backend for your game. Your backend requests a short-lived ticket on behalf of a player, your game client uses that ticket to open a WebSocket connection, and from there the client queues for a match, keeps the connection alive with heartbeats, and reconnects gracefully if it drops.
Getting Started
Step by step, from a fresh account to a player in a match.
1. Account Setup
Sign up, pick a tier, and generate an API key for your backend.
2. Generate a Ticket
Exchange your API key for a short-lived ticket your game client can use.
3. Connect via WebSocket
Open a connection to the matchmaking gateway using the ticket.
4. Parties
Optional: let friends group up before searching and queue together.
5. Start a Search
Queue the player for a match and handle the response.
6. Match Made
What the client and your backend each receive once a match is formed.
7. Heartbeats & Disconnects
Keep an active search alive and recover gracefully from drops.
Configuration
Reference for the parts of your tenant you configure in the dashboard, outside the step-by-step flow.
SDKs
Client libraries that handle the ticket, WebSocket, and reconnect details for you.
Reference
Machine-readable specifications for code generators, API clients, and AI assistants.