view mod_pubsub_twitter/README.markdown @ 4575:5b4f43b90766

mod_measure_malloc: port to most recent trunk statistics API
author Jonas Schäfer <>
date Tue, 25 May 2021 19:01:54 +0200
parents 4d73a1a6ba68
line wrap: on
line source

- 'Stage-Alpha'
summary: Subscribe to Twitter search queries over pubsub


Twitter has an open 'realtime' search API, but it requires polling
(within their rate limits). This module allows Prosody to poll for you,
and push new results to subscribers over XMPP.


This module must be loaded on a Prosody pubsub component. Add it to
`modules_enabled` and configure like so:

    Component "" "pubsub"
    modules_enabled = { "pubsub_twitter" }

    twitter_searches = {
      realtime = "xmpp OR realtime";
      prosody = "prosody xmpp";

This example creates two nodes, 'realtime' and 'prosody' that clients
can subscribe to using
[XEP-0060]( Results are in
[ATOM 1.0 format]( for easy consumption.

  Option                    Description
  ------------------------- --------------------------------------------------------------------------------
  twitter\_searches         A list of virtual nodes to create and their associated Twitter search queries.
  twitter\_pull\_interval   Number of minutes between polling for new results (default 20)
  twitter\_search\_url      URL of the JSON search API, default: ""


  ----- -------
  0.9   Works
  ----- -------