diego

diego / GetUserTweets / 0.2.1

README.md

0. TL;DR

Retrieve a users latest tweets

1. Introduction

You can retrieve any given number of tweets (according to Twitter's Rate Limit).

Input

  • (Required): The query keyword/string
  • (Required): Twitter API authentication keys

Output:

  • A list of tweets objects.

2. Query

The query user: The user that you're searching for on Twitter.

Example of a query keyword/string:

{
    "query": "algorithmia"
}

3. Authentication

Twitter API authentication keys: The API keys that are necessary to access Twitter API service. You can get yours here. (key = "auth")

{
    "auth": {
        "app_key": "xxxxxxx",
        "app_secret": "xxxxxxx",
        "oauth_token": "xxxxxxx",
        "oauth_token_secret": "xxxxxxx"
    }
}

4. Output

A list of tweet objects: This is the list of relevant tweet objects for your query. To get more information about the structure about the tweet objects click here.

Example of a list of tweets:

[
    tweet_object_1,
    tweet_object_2,
    ...,
    tweet_object_n
]

5. Example

Example 1:

  • Parameter 1: A query keyword/string
  • Parameter 3: Twitter API authentication keys
{
    "query": "algorithmia",
    "auth": {
        "app_key": "xxxxxxx",
        "app_secret": "xxxxxxx",
        "oauth_token": "xxxxxxx",
        "oauth_token_secret": "xxxxxxx"
    }
}

6. Credits

For more information, please visit the Python package Twython and Twitter Dev Center.