What this API does
The Liveblocks Realtime API allows developers to seamlessly integrate real-time collaboration features into their web applications. It supports live cursors, multiplayer editing, presence indicators, and synchronized shared storage based on CRDT algorithms for conflict-free data management.
How it works
Designed for performance and scalability, the API ensures low latency updates across users. It is compatible with modern frontend frameworks like React, Vue, and also supports vanilla JavaScript. Developers can utilize various endpoints to facilitate collaboration and shared state management.
Authentication
Authentication is secured with API keys, enabling granular access control for different application roles. Developers must include these keys in requests to access various features.
Example usage
/v1/presence- Fetches the presence information of users in the collaborative session./v1/shared-state- Updates shared states in real time among users./v1/live-events- Subscribes to live events for real-time updates.
Limits
Free plan allows up to 50 concurrent users and 100K operations per month. Additional usage may require a higher tier.
Ideal use cases
- Collaborative editors for text or code.
- Chat applications with real-time messaging.
- Online whiteboards for brainstorming sessions.
- Multiplayer games requiring real-time interactions.