Data is collected from Twitter using their v2 API endpoints and syntax. This codebase assumes that you have academic access with your tokens because they are needed to utilize the API's full-archive search capabilities.

See the full documentation for more details.

First, rules need to be specified in the event query configuration file according to Twitter's filter stream syntax rules. See an example here.

Once the event configuration file is ready, the command for streaming tweets is

python -m twitter.stream event_name

The stream can be cancelled at any time with CTRL+C.

All other Twitter data is collected as a type of search. Like the stream, the search needs to be specified using an event configuration file using Twitter's search syntax. See an example here, and note that the search configuration format is different than the stream configuration format.

Once the event configuration file is ready, the command for streaming tweets is

python -m twitter.search event_name

The search can be cancelled at any time with CTRL+C.

See the full documentation for more information about searching and streaming tweets, and how to collect conversations, quotes, and timelines.