Home

Introduction

The OSoMeTweet project intends to provide a set of tools to help researchers work with the V2 API of Twitter. The Wiki provides detailed instructions about the tools and will work as an unofficial archive of knowledge people gather through the process.

osometweet package examples

For instructions like how to install the package, see the README.md.

Authentication

Before you can gather any data from Twitter, you must create an authentication object. See page Authentication for instructions on how to create an authentication object and use it to initialize the OsomeTweet class.

Tweet endpoints

Tweet endpoints allow fetching tweets from the API. Here are the endpoints currently supported by osometweet:

• Tweet lookup
• Timelines (User Tweets and Mentions)

User endpoints

User endpoints allow fetching user information from the API. Here are the endpoints currently supported by osometweet:

• User lookup
• Follows lookup (Followers and Following)

Fields & expansions

V2 API by default only returns limited information. To fetch more, you will need to specify the fields and expansions parameters in the requests. OSoMeTweet contains several classes to handle them. See Specifying fields and expansions for examples of who to work with them.

Utility Methods (osometweet.utils)

osometweet offers some utility functions to make your life easier, see Utility functions for details.

Official documentations

• Twitter API v2 Sample Code
• HTTP Status Codes and Errors
• Twitter API V2 Endpoints
• Available Fields and Expansions