Subscribe to server-sent events for real-time updates via a long-lived HTTP connection or via WebSocket.
Your application can use a server-sent events endpoint to receive updates in real-time. Server-sent events is an incredibly simple transport method that relies entirely on chunked-encoding transfer, i.e. the HTTP connection is kept open and receives new data periodically.
Alternatively, a WebSocket connection can also be established.
Server-sent events (HTTP)
OK when streaming service is fine. Added in 2.5.0
Returns events that are relevant to the authorized user, i.e. home timeline and notifications
Returns all public statuses
Returns all local statuses
Returns all public statuses for a particular hashtag
Returns all local statuses for a particular hashtag
Returns statuses for a list
Returns all direct messages
The stream will contain events as well as heartbeat comments. Lines that begin with a colon (
:) can be ignored by parsers, they are simply there to keep the connection open. Events have this structure:
event: name data: payload
For WebSockets, there is only one URL path (
/api/v1/streaming). The access token as well as the endpoint you are interested in must be provided with query params, respectively
stream. Query params
tag are likewise supported for relevant endpoints.
|Event||Description||What’s in the payload|
||A new status has appeared||Status|
||A new notification has appeared||Notification|
||A status has been deleted||ID of the deleted status|
||Keyword filters have been changed|
The payload is JSON-encoded.
payloadis not defined.