Tweepy Documentation

Contents:

• Installation
• Getting started
  • Introduction
  • Hello Tweepy
  • API
  • Models
• Authentication
  • Introduction
  • Twitter API v1.1
  • Twitter API v2
  • 3-legged OAuth
  • Reference
• Logging
• Streaming
  • Using Stream
  • Using StreamingClient
  • Threading
  • Handling Errors

Twitter API v1.1 Reference

• API
  • API
  • Premium Search APIs
    • API.search_30_day()
    • API.search_full_archive()
  • Tweets
    • Get Tweet timelines
      • API.home_timeline()
      • API.mentions_timeline()
      • API.user_timeline()
    • Post, retrieve, and engage with Tweets
      • API.get_favorites()
      • API.lookup_statuses()
      • API.get_oembed()
      • API.get_retweeter_ids()
      • API.get_retweets()
      • API.get_retweets_of_me()
      • API.get_status()
      • API.create_favorite()
      • API.destroy_favorite()
      • API.destroy_status()
      • API.retweet()
      • API.unretweet()
      • API.update_status()
      • API.update_status_with_media()
    • Search Tweets
      • API.search_tweets()
  • Accounts and users
    • Create and manage lists
      • API.get_lists()
      • API.get_list_members()
      • API.get_list_member()
      • API.get_list_memberships()
      • API.get_list_ownerships()
      • API.get_list()
      • API.list_timeline()
      • API.get_list_subscribers()
      • API.get_list_subscriber()
      • API.get_list_subscriptions()
      • API.create_list()
      • API.destroy_list()
      • API.add_list_member()
      • API.add_list_members()
      • API.remove_list_member()
      • API.remove_list_members()
      • API.subscribe_list()
      • API.unsubscribe_list()
      • API.update_list()
    • Follow, search, and get users
      • API.get_follower_ids()
      • API.get_followers()
      • API.get_friend_ids()
      • API.get_friends()
      • API.incoming_friendships()
      • API.lookup_friendships()
      • API.no_retweets_friendships()
      • API.outgoing_friendships()
      • API.get_friendship()
      • API.lookup_users()
      • API.search_users()
      • API.get_user()
      • API.create_friendship()
      • API.destroy_friendship()
      • API.update_friendship()
    • Manage account settings and profile
      • API.get_settings()
      • API.verify_credentials()
      • API.get_saved_searches()
      • API.get_saved_search()
      • API.get_profile_banner()
      • API.remove_profile_banner()
      • API.set_settings()
      • API.update_profile()
      • API.update_profile_banner()
      • API.update_profile_image()
      • API.create_saved_search()
      • API.destroy_saved_search()
    • Mute, block, and report users
      • API.get_blocked_ids()
      • API.get_blocks()
      • API.get_muted_ids()
      • API.get_mutes()
      • API.create_block()
      • API.destroy_block()
      • API.create_mute()
      • API.destroy_mute()
      • API.report_spam()
  • Direct Messages
    • Sending and receiving events
      • API.delete_direct_message()
      • API.get_direct_messages()
      • API.get_direct_message()
      • API.send_direct_message()
    • Typing indicator and read receipts
      • API.indicate_direct_message_typing()
      • API.mark_direct_message_read()
  • Media
    • Upload media
      • API.get_media_upload_status()
      • API.create_media_metadata()
      • API.media_upload()
      • API.simple_upload()
      • API.chunked_upload()
      • API.chunked_upload_append()
      • API.chunked_upload_finalize()
      • API.chunked_upload_init()
  • Trends
    • Get locations with trending topics
      • API.available_trends()
      • API.closest_trends()
    • Get trends near a location
      • API.get_place_trends()
  • Geo
    • Get information about a place
      • API.geo_id()
    • Get places near a location
      • API.reverse_geocode()
      • API.search_geo()
  • Developer utilities
    • Get Twitter supported languages
      • API.supported_languages()
    • Get app rate limit status
      • API.rate_limit_status()
• Stream
  • Stream
    • Stream.running
    • Stream.session
    • Stream.thread
    • Stream.user_agent
    • Stream.filter()
    • Stream.sample()
    • Stream.on_data()
    • Stream.on_status()
    • Stream.on_delete()
    • Stream.on_disconnect_message()
    • Stream.on_limit()
    • Stream.on_scrub_geo()
    • Stream.on_status_withheld()
    • Stream.on_user_withheld()
    • Stream.on_warning()
    • Stream.disconnect()
    • Stream.on_closed()
    • Stream.on_connect()
    • Stream.on_connection_error()
    • Stream.on_disconnect()
    • Stream.on_exception()
    • Stream.on_keep_alive()
    • Stream.on_request_error()
• AsyncStream
  • AsyncStream
    • AsyncStream.session
    • AsyncStream.task
    • AsyncStream.user_agent
    • AsyncStream.filter()
    • AsyncStream.sample()
    • AsyncStream.on_data()
    • AsyncStream.on_status()
    • AsyncStream.on_delete()
    • AsyncStream.on_disconnect_message()
    • AsyncStream.on_limit()
    • AsyncStream.on_scrub_geo()
    • AsyncStream.on_status_withheld()
    • AsyncStream.on_user_withheld()
    • AsyncStream.on_warning()
    • AsyncStream.disconnect()
    • AsyncStream.on_closed()
    • AsyncStream.on_connect()
    • AsyncStream.on_connection_error()
    • AsyncStream.on_disconnect()
    • AsyncStream.on_exception()
    • AsyncStream.on_keep_alive()
    • AsyncStream.on_request_error()
• Exceptions
  • TweepyException
  • HTTPException
    • HTTPException.response
    • HTTPException.api_errors
    • HTTPException.api_codes
    • HTTPException.api_messages
  • BadRequest
  • Unauthorized
  • Forbidden
  • NotFound
  • TooManyRequests
  • TwitterServerError
• Models
  • tweepy.models.BoundingBox
  • tweepy.models.DirectMessage
  • tweepy.models.Friendship
  • tweepy.models.List
  • tweepy.models.Media
  • tweepy.models.Place
  • tweepy.models.Relationship
  • tweepy.models.SavedSearch
  • tweepy.models.SearchResults
  • tweepy.models.Status
  • tweepy.models.User
• Pagination
  • Cursor
    • Cursor.items()
    • Cursor.pages()

• Extended Tweets

Twitter API v2 Reference

• Client
  • Client
    • Client.session
    • Client.user_agent
  • Tweets
    • Bookmarks
      • Client.remove_bookmark()
      • Client.get_bookmarks()
      • Client.bookmark()
    • Hide replies
      • Client.hide_reply()
      • Client.unhide_reply()
    • Likes
      • Client.unlike()
      • Client.get_liking_users()
      • Client.get_liked_tweets()
      • Client.like()
    • Manage Tweets
      • Client.delete_tweet()
      • Client.create_tweet()
    • Quote Tweets
      • Client.get_quote_tweets()
    • Retweets
      • Client.unretweet()
      • Client.get_retweeters()
      • Client.retweet()
    • Search Tweets
      • Client.search_all_tweets()
      • Client.search_recent_tweets()
    • Timelines
      • Client.get_users_mentions()
      • Client.get_home_timeline()
      • Client.get_users_tweets()
    • Tweet counts
      • Client.get_all_tweets_count()
      • Client.get_recent_tweets_count()
    • Tweet lookup
      • Client.get_tweet()
      • Client.get_tweets()
  • Users
    • Blocks
      • Client.unblock()
      • Client.get_blocked()
      • Client.block()
    • Follows
      • Client.unfollow_user()
      • Client.unfollow()
      • Client.get_users_followers()
      • Client.get_users_following()
      • Client.follow_user()
      • Client.follow()
    • Mutes
      • Client.unmute()
      • Client.get_muted()
      • Client.mute()
    • User lookup
      • Client.get_user()
      • Client.get_users()
      • Client.get_me()
  • Spaces
    • Search Spaces
      • Client.search_spaces()
    • Spaces lookup
      • Client.get_spaces()
      • Client.get_space()
      • Client.get_space_buyers()
      • Client.get_space_tweets()
  • Direct Messages
    • Direct Messages lookup
      • Client.get_direct_message_events()
    • Manage Direct Messages
      • Client.create_direct_message()
      • Client.create_direct_message_conversation()
  • Lists
    • List Tweets lookup
      • Client.get_list_tweets()
    • List follows
      • Client.unfollow_list()
      • Client.get_list_followers()
      • Client.get_followed_lists()
      • Client.follow_list()
    • List lookup
      • Client.get_list()
      • Client.get_owned_lists()
    • List members
      • Client.remove_list_member()
      • Client.get_list_members()
      • Client.get_list_memberships()
      • Client.add_list_member()
    • Manage Lists
      • Client.delete_list()
      • Client.update_list()
      • Client.create_list()
    • Pinned Lists
      • Client.unpin_list()
      • Client.get_pinned_lists()
      • Client.pin_list()
  • Compliance
    • Batch compliance
      • Client.get_compliance_jobs()
      • Client.get_compliance_job()
      • Client.create_compliance_job()
• Response
  • Response
• StreamingClient
  • StreamingClient
    • StreamingClient.running
    • StreamingClient.session
    • StreamingClient.thread
    • StreamingClient.user_agent
    • StreamingClient.add_rules()
    • StreamingClient.delete_rules()
    • StreamingClient.filter()
    • StreamingClient.get_rules()
    • StreamingClient.sample()
    • StreamingClient.on_data()
    • StreamingClient.on_tweet()
    • StreamingClient.on_includes()
    • StreamingClient.on_errors()
    • StreamingClient.on_matching_rules()
    • StreamingClient.on_response()
    • StreamingClient.disconnect()
    • StreamingClient.on_closed()
    • StreamingClient.on_connect()
    • StreamingClient.on_connection_error()
    • StreamingClient.on_disconnect()
    • StreamingClient.on_exception()
    • StreamingClient.on_keep_alive()
    • StreamingClient.on_request_error()
• StreamResponse
  • StreamResponse
• StreamRule
  • StreamRule
• AsyncClient
  • AsyncClient
    • AsyncClient.session
    • AsyncClient.user_agent
  • Tweets
    • Bookmarks
      • AsyncClient.remove_bookmark()
      • AsyncClient.get_bookmarks()
      • AsyncClient.bookmark()
    • Hide replies
      • AsyncClient.hide_reply()
      • AsyncClient.unhide_reply()
    • Likes
      • AsyncClient.unlike()
      • AsyncClient.get_liking_users()
      • AsyncClient.get_liked_tweets()
      • AsyncClient.like()
    • Manage Tweets
      • AsyncClient.delete_tweet()
      • AsyncClient.create_tweet()
    • Quote Tweets
      • AsyncClient.get_quote_tweets()
    • Retweets
      • AsyncClient.unretweet()
      • AsyncClient.get_retweeters()
      • AsyncClient.retweet()
    • Search Tweets
      • AsyncClient.search_all_tweets()
      • AsyncClient.search_recent_tweets()
    • Timelines
      • AsyncClient.get_users_mentions()
      • AsyncClient.get_home_timeline()
      • AsyncClient.get_users_tweets()
    • Tweet counts
      • AsyncClient.get_all_tweets_count()
      • AsyncClient.get_recent_tweets_count()
    • Tweet lookup
      • AsyncClient.get_tweet()
      • AsyncClient.get_tweets()
  • Users
    • Blocks
      • AsyncClient.unblock()
      • AsyncClient.get_blocked()
      • AsyncClient.block()
    • Follows
      • AsyncClient.unfollow_user()
      • AsyncClient.get_users_followers()
      • AsyncClient.get_users_following()
      • AsyncClient.follow_user()
    • Mutes
      • AsyncClient.unmute()
      • AsyncClient.get_muted()
      • AsyncClient.mute()
    • User lookup
      • AsyncClient.get_user()
      • AsyncClient.get_users()
      • AsyncClient.get_me()
  • Spaces
    • Search Spaces
      • AsyncClient.search_spaces()
    • Spaces lookup
      • AsyncClient.get_spaces()
      • AsyncClient.get_space()
      • AsyncClient.get_space_buyers()
      • AsyncClient.get_space_tweets()
  • Direct Messages
    • Direct Messages lookup
      • AsyncClient.get_direct_message_events()
    • Manage Direct Messages
      • AsyncClient.create_direct_message()
      • AsyncClient.create_direct_message_conversation()
  • Lists
    • List Tweets lookup
      • AsyncClient.get_list_tweets()
    • List follows
      • AsyncClient.unfollow_list()
      • AsyncClient.get_list_followers()
      • AsyncClient.get_followed_lists()
      • AsyncClient.follow_list()
    • List lookup
      • AsyncClient.get_list()
      • AsyncClient.get_owned_lists()
    • List members
      • AsyncClient.remove_list_member()
      • AsyncClient.get_list_members()
      • AsyncClient.get_list_memberships()
      • AsyncClient.add_list_member()
    • Manage Lists
      • AsyncClient.delete_list()
      • AsyncClient.update_list()
      • AsyncClient.create_list()
    • Pinned Lists
      • AsyncClient.unpin_list()
      • AsyncClient.get_pinned_lists()
      • AsyncClient.pin_list()
  • Compliance
    • Batch compliance
      • AsyncClient.get_compliance_jobs()
      • AsyncClient.get_compliance_job()
      • AsyncClient.create_compliance_job()
• AsyncStreamingClient
  • AsyncStreamingClient
    • AsyncStreamingClient.session
    • AsyncStreamingClient.task
    • AsyncStreamingClient.user_agent
    • AsyncStreamingClient.add_rules()
    • AsyncStreamingClient.delete_rules()
    • AsyncStreamingClient.filter()
    • AsyncStreamingClient.get_rules()
    • AsyncStreamingClient.sample()
    • AsyncStreamingClient.on_data()
    • AsyncStreamingClient.on_tweet()
    • AsyncStreamingClient.on_includes()
    • AsyncStreamingClient.on_errors()
    • AsyncStreamingClient.on_matching_rules()
    • AsyncStreamingClient.on_response()
    • AsyncStreamingClient.disconnect()
    • AsyncStreamingClient.on_closed()
    • AsyncStreamingClient.on_connect()
    • AsyncStreamingClient.on_connection_error()
    • AsyncStreamingClient.on_disconnect()
    • AsyncStreamingClient.on_exception()
    • AsyncStreamingClient.on_keep_alive()
    • AsyncStreamingClient.on_request_error()
• Exceptions
  • TweepyException
  • HTTPException
    • HTTPException.response
    • HTTPException.api_errors
    • HTTPException.api_codes
    • HTTPException.api_messages
  • BadRequest
  • Unauthorized
  • Forbidden
  • NotFound
  • TooManyRequests
  • TwitterServerError
• Expansions and Fields
  • expansions
  • list_fields
  • media_fields
  • place_fields
  • poll_fields
  • space_fields
  • tweet_fields
  • user_fields
• Models
  • DirectMessageEvent
    • DirectMessageEvent
      • DirectMessageEvent.data
      • DirectMessageEvent.id
      • DirectMessageEvent.event_type
      • DirectMessageEvent.attachments
      • DirectMessageEvent.created_at
      • DirectMessageEvent.dm_conversation_id
      • DirectMessageEvent.participant_ids
      • DirectMessageEvent.referenced_tweets
      • DirectMessageEvent.sender_id
      • DirectMessageEvent.text
  • List
    • List
      • List.data
      • List.id
      • List.name
      • List.created_at
      • List.description
      • List.follower_count
      • List.member_count
      • List.private
      • List.owner_id
  • Media
    • Media
      • Media.data
      • Media.media_key
      • Media.type
      • Media.url
      • Media.duration_ms
      • Media.height
      • Media.non_public_metrics
      • Media.organic_metrics
      • Media.preview_image_url
      • Media.promoted_metrics
      • Media.public_metrics
      • Media.width
      • Media.alt_text
      • Media.variants
  • Place
    • Place
      • Place.data
      • Place.full_name
      • Place.id
      • Place.contained_within
      • Place.country
      • Place.country_code
      • Place.geo
      • Place.name
      • Place.place_type
  • Poll
    • Poll
      • Poll.data
      • Poll.id
      • Poll.options
      • Poll.duration_minutes
      • Poll.end_datetime
      • Poll.voting_status
  • Space
    • Space
      • Space.data
      • Space.id
      • Space.state
      • Space.created_at
      • Space.ended_at
      • Space.host_ids
      • Space.lang
      • Space.is_ticketed
      • Space.invited_user_ids
      • Space.participant_count
      • Space.subscriber_count
      • Space.scheduled_start
      • Space.speaker_ids
      • Space.started_at
      • Space.title
      • Space.topic_ids
      • Space.updated_at
  • Tweet
    • Tweet
      • Tweet.data
      • Tweet.id
      • Tweet.text
      • Tweet.edit_history_tweet_ids
      • Tweet.attachments
      • Tweet.author_id
      • Tweet.context_annotations
      • Tweet.conversation_id
      • Tweet.created_at
      • Tweet.edit_controls
      • Tweet.entities
      • Tweet.geo
      • Tweet.in_reply_to_user_id
      • Tweet.lang
      • Tweet.non_public_metrics
      • Tweet.organic_metrics
      • Tweet.possibly_sensitive
      • Tweet.promoted_metrics
      • Tweet.public_metrics
      • Tweet.referenced_tweets
      • Tweet.reply_settings
      • Tweet.source
      • Tweet.withheld
    • ReferencedTweet
      • ReferencedTweet.data
      • ReferencedTweet.id
      • ReferencedTweet.type
  • User
    • User
      • User.data
      • User.id
      • User.name
      • User.username
      • User.created_at
      • User.description
      • User.entities
      • User.location
      • User.pinned_tweet_id
      • User.profile_image_url
      • User.protected
      • User.public_metrics
      • User.url
      • User.verified
      • User.withheld
• Pagination
  • Paginator
    • Paginator.flatten()
  • AsyncPaginator
    • AsyncPaginator.flatten()

Meta

• Development
  • Running Tests
  • Contributors
• Examples
• Frequently Asked Questions
  • General
  • Tweepy v4
  • Twitter API v2

Indices and tables

• Index

• Search Page