{"componentChunkName":"component---src-pages-author-author-yaml-id-js","path":"/author/sameer-mahajan/","result":{"data":{"allMarkdownRemark":{"edges":[{"node":{"id":"cc7e7d30-fceb-5d64-afa5-a9da979d7ce5","html":"

As we all know, Twitter is one of the most preferred microblogging websites when it comes to putting your thoughts on the internet. Big organizations use this platform for advertising their product; government institutions even use it to provide prompt customer resolution; various groups use Twitter to run social awareness campaigns and media campaigns. Twitter has close to 330 million monthly active users worldwide, out of which 17 million hits are generated from India itself along with more than 1 billion downloads on Play Store. With all this in mind, Twitter allows access to Twitter API to developers to create some cool applications like bots, automation tools, etc. This Twitter API gives developers access to almost all of Twitter's functionalities like likes, retweets, tweets, etc. Tweepy, a python package, helps us in achieving all this.

\n

Tweepy is a python package that smoothly and transparently accesses Twitter's endpoints made available for the developers. Without Tweepy, the user would have to take care of various low-level details about HTTP requests, rate limiting, authentication, serialization, etc. Tweepy handles all this mess on behalf of the user making the application prone to errors.\nIn simple words, Tweepy is an open-source python package that provides a way for developers to communicate with the Twitter API. But keep in mind that Twitter levies a rate limit on the number of requests made to the Twitter API. To be precise, 900 requests/15 minutes are allowed; Twitter feeds anything above that an error.

\n

Installation

\n

Tweepy can be installed by using Python package manager pip. A simple demonstration can be seen below:\n\"installation\"

\n

Installation on Linux and macOS should follow similar steps as well.

\n

Twitter API uses OAuth for authentication, so initially, you need to apply for authentication credentials from Twitter. These authentication credentials basically consists of 4 components namely : consumerkey, consumersecretkey, accesstoken, accesstokensecret . These credentials from Twitter are used to instantiate the API. Each account gets a unique key, so don't reuse someone else's keys.\nFor getting those credentials from Twitter, apply for a developer account on the Twitter Developers page.\n\"twitterdev\"\nThis is what the account looks like. Here you will get detailed information about the total no. of requests made, your API credentials, and much more information. After creating an account, you need to create an app wherein you will be asked to name your app and a short description. You must be wondering what an app is?\nThe app is like a gateway that contains a set of permissions and keys used to access the Twitter API. An app is needed for accessing the Twitter API as a part of Twitter's OAuth authentication. After creating an app, generate new authentication tokens for authorization purposes.

\n

\"keys\"

\n

Getting Started: Tweepy

\n

There are four common basic steps in any Tweepy application.

\n
    \n
  1. Importing tweepy package.
    2. \n
  2. Setting the authentication credentials.
    3. \n
  3. Instantiating the API.
    4. \n
  4. Creating API object.
    5. \n
\n
import tweepy\n# authenticating twitter api credentials\nconsumer_key = '2OsNoPKOYCpxxxxxxxxxxxxxxxxxxxxxx'\nconsumer_secret = 'Xw07uU51xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'\naccess_token = '24621057xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'\naccess_token_secret = 'pXt5xxxxxxxxxxxxxxxxxxxxxxxxxxxx'\n\n# instantiating the api\nauth = tweepy.OAuthHandler(consumer_key, consumer_secret)\nauth.set_access_token(access_token, access_token_secret)\n\n# creating API object\n\napi = tweepy.API(auth,wait_on_rate_limit=True,wait_on_rate_limit_notify=True)\n\nimport tabulate\nuser = api.get_user("Cristiano")\nprint("User Details:")\nprint(tabulate([["Name","Description","Location"],[user.name,user.description,user.location]],headers="firstrow"))
\n
\n

Note: Use your credentials in the hidden keys above._

\n
\n

Objects created from the Tweepy. API class helps us access most of Twitter's available functionality like tweets, retweets, likes, etc. In the code snippet, we used the api.get_user method for getting information about a certain user on Twitter. Likewise, there can be several use cases of different methods(discussed below) made available by Twitter to developers. You can find the link for this code here.

\n

Now we will see different methods provided by Twitter. The API methods have been divided into groups based on their functionality. The detailed guide for the API methods can be found at the official API Reference documentation.

\n\n

Timeline Methods

\n

These methods handles the tweets, retweets, statuses on your/someone else's timeline as long as the account is public.

\n
tweets = api.home_timeline()\nfor tweet in tweets:\n    print(f"{tweet.user.name} said {tweet.text}")
\n

api.home_timeline() is an API method that returns the 20 most recent tweets on the user's timeline.

\n

Status Methods

\n

These methods deal with creating, fetching tweets, retweeting tweets.

\n
api.update_status("Hello World!")
\n

api.update_status() is an API method used to create a tweet on the user's timeline. For each update request, it will check the user's recent tweets. If any duplication is found, the request will be blocked by Twitter as a user cannot post the same tweet more than once.

\n

User Methods

\n

These methods help to find the user details using various paramaeter like name, location, description,friends, followers,etc. as long as the account is public.

\n
user = api.get_user("ISRO")\nprint(user.name)\nprint(user.decscription)\nprint(user.followers)\nprint(user.location)
\n

We have used get_user() previously to fetch user details of specific accounts.

\n

Friendship Methods

\n

These methods help the user to follow, unfollow certain accounts, list the accounts user follows, etc.

\n
api.create_friendship("elonmusk")
\n

create_friendship() will add @elonmusk to the list of accounts you follow.

\n

Favorite Methods

\n

Likes or unlikes(if already liked) the status specified in the ID parameter as the authenticating user.

\n
api.create_favorite(tweet.id)
\n

create_favorite() will like a tweet based on the tweet id provided.

\n

Block Methods

\n

Used to block, unblock, list blocked accounts of the user.

\n
api.create_block(id/screen_name)
\n

createblock() will block the specific user using the id/screenname provided.

\n

Search Methods

\n

These methods help the user to search specific tweet based upon the search query and parameters provided. But not all tweets will be indexed or made available through the search methods.

\n
for tweets in api.search(q="iphone", lang="en"):\n    print(tweet.text)
\n

search() will look out for all the tweets available for the query keyword 'q' provided.

\n

Trends Methods

\n

It returns the trends going on at a specific geographical location.

\n
api.trends_place(1)
\n

trends_place() will show trends in the specific area. Here one stands for worldwide.

\n

Geo Methods

\n

It returns the geographical location like latitude, the longitude of the place id provided.

\n
api.geo_id(id)
\n

geo_id() returns more geographical information of the concerned place id.

\n

Conclusion

\n

Tweepy allows the user to concentrate on the application's logic by hiding many low-level details, thus making the application bug-free. You can use tweepy to do some cool projects like bots, automation, machine learning applications, etc.

\n
Ket Takeaways
\n\n

More information about tweepy can be found at docs. Make sure to look at the official documentation as it will provide you with a greater picture of the package. So what are you waiting for? Go ahead, use your imagination, and get started with the side-project you've always been thinking of.

\n","frontmatter":{"title":"Beginners Guide to Tweepy ","author":{"id":"Sameer Mahajan","github":"sameermahajan101","avatar":null},"date":"November 02, 2020","updated_date":null,"tags":["Twitter","Tweepy","Python"],"coverImage":{"childImageSharp":{"fluid":{"aspectRatio":1.5037593984962405,"src":"/static/63d4d3ea1070111c43e0bdfa476b2a62/14b42/coverimage.jpg","srcSet":"/static/63d4d3ea1070111c43e0bdfa476b2a62/f836f/coverimage.jpg 200w,\n/static/63d4d3ea1070111c43e0bdfa476b2a62/2244e/coverimage.jpg 400w,\n/static/63d4d3ea1070111c43e0bdfa476b2a62/14b42/coverimage.jpg 800w,\n/static/63d4d3ea1070111c43e0bdfa476b2a62/47498/coverimage.jpg 1200w,\n/static/63d4d3ea1070111c43e0bdfa476b2a62/0e329/coverimage.jpg 1600w,\n/static/63d4d3ea1070111c43e0bdfa476b2a62/d8255/coverimage.jpg 1920w","sizes":"(max-width: 800px) 100vw, 800px"}}}},"fields":{"authorId":"Sameer Mahajan","slug":"/engineering/beginners-guide-to-tweepy/"}}}]},"authorYaml":{"id":"Sameer Mahajan","bio":"Recent Computer Science Graduate","github":"sameermahajan101","stackoverflow":"11896352","linkedin":"sameer-mahajan-777105127","medium":null,"twitter":"sameermahan101","avatar":null}},"pageContext":{"id":"Sameer Mahajan","__params":{"id":"sameer-mahajan"}}},"staticQueryHashes":["1171199041","1384082988","2100481360","23180105","528864852"]}