Streaming
Subscribe to server-sent events for real-time updates via a long-lived HTTP connection or via WebSocket.
https://docs.joinmastodon.org/methods/streaming/
All methods currently lack proper documentation via kDoc comments.
Endpoint | Status | Comments |
---|---|---|
GET /api/v1/streaming/health Check if the server is alive | Fully supported. | |
GET /api/v1/streaming/user Watch your home timeline and notifications | Implemented via WebSocket endpoint. | |
GET /api/v1/streaming/user/notification Watch your notifications | Implemented via WebSocket endpoint. | |
GET /api/v1/streaming/public Watch the federated timeline | Implemented via WebSocket endpoint. | |
GET /api/v1/streaming/public/local Watch the local timeline | Implemented via WebSocket endpoint. | |
GET /api/v1/streaming/public/remote Watch for remote statuses | Implemented via WebSocket endpoint. | |
GET /api/v1/streaming/hashtag Watch the public timeline for a hashtag | Implemented via WebSocket endpoint. | |
GET /api/v1/streaming/hashtag/local Watch the local timeline for a hashtag | Implemented via WebSocket endpoint. | |
GET /api/v1/streaming/list Watch for list updates | Implemented via WebSocket endpoint. | |
GET /api/v1/streaming/direct Watch for direct messages | Implemented via WebSocket endpoint. | |
GET wss://$instance/api/v1/streaming Establishing a WebSocket connection | Exposed as individual methods as seen above. |