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.
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 (query param
Returns statuses for list (query param
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
|Event||Description||What's in the payload|
||A new status has appeared!||Status|
||A new notification||Notification|
||A status has been deleted||ID of the deleted status|
||Keyword filters have been changed||Not exists. (undefined)|
The payload is JSON-encoded.
Note: In case of
payloadis not defined.