Skip to content

Latest commit

 

History

History
644 lines (513 loc) · 43 KB

api.rst

File metadata and controls

644 lines (513 loc) · 43 KB

tweepy

API

API

Twitter API v1.1 Endpoint API Method

Premium Search APIs

GET search/30day/:label API.search_30_day
GET search/fullarchive/:label API.search_full_archive

Tweets

Get Tweet timelines_

GET statuses/home_timeline API.home_timeline
GET statuses/mentions_timeline API.mentions_timeline
GET statuses/user_timeline API.user_timeline

|Post, retrieve, and engage

with Tweets|_
GET favorites/list API.get_favorites
GET statuses/lookup API.lookup_statuses
GET statuses/oembed API.get_oembed
GET statuses/retweeters/ids API.get_retweeter_ids
GET statuses/retweets/:id API.get_retweets
GET statuses/retweets_of_me API.get_retweets_of_me
GET statuses/show/:id API.get_status
POST favorites/create API.create_favorite
POST favorites/destroy API.destroy_favorite
POST statuses/destroy/:id API.destroy_status
POST statuses/retweet/:id API.retweet
POST statuses/unretweet/:id API.unretweet
POST statuses/update API.update_status
POST statuses/update_with_media API.update_status_with_media

Search Tweets_

GET search/tweets API.search_tweets

Accounts and users

Create and manage lists_

GET lists/list API.get_lists
GET lists/members API.get_list_members
GET lists/members/show API.get_list_member
GET lists/memberships API.get_list_memberships
GET lists/ownerships API.get_list_ownerships
GET lists/show API.get_list
GET lists/statuses API.list_timeline
GET lists/subscribers API.get_list_subscribers
GET lists/subscribers/show API.get_list_subscriber
GET lists/subscriptions API.get_list_subscriptions
POST lists/create API.create_list
POST lists/destroy API.destroy_list
POST lists/members/create API.add_list_member
POST lists/members/create_all API.add_list_members
POST lists/members/destroy API.remove_list_member
POST lists/members/destroy_all API.remove_list_members
POST lists/subscribers/create API.subscribe_list
POST lists/subscribers/destroy API.unsubscribe_list
POST lists/update API.update_list

|Follow, search, and get use

rs|_
GET followers/ids API.get_follower_ids
GET followers/list API.get_followers
GET friends/ids API.get_friend_ids
GET friends/list API.get_friends
GET friendships/incoming API.incoming_friendships
GET friendships/lookup API.lookup_friendships
GET friendships/no_retweets/ids API.no_retweets_friendships
GET friendships/outgoing API.outgoing_friendships
GET friendships/show API.get_friendship
GET users/lookup API.lookup_users
GET users/search API.search_users
GET users/show API.get_user
POST friendships/create API.create_friendship
POST friendships/destroy API.destroy_friendship
POST friendships/update API.update_friendship

|Manage account settings and

profile|_
GET account/settings API.get_settings
GET account/verify_credentials API.verify_credentials
GET saved_searches/list API.get_saved_searches
GET saved_searches/show/:id API.get_saved_search
GET users/profile_banner API.get_profile_banner
POST account/remove_profile_banner API.remove_profile_banner
POST account/settings API.set_settings
POST account/update_profile API.update_profile
POST account/update_profile_banner API.update_profile_banner
POST account/update_profile_image API.update_profile_image
POST saved_searches/create API.create_saved_search
POST saved_searches/destroy/:id API.destroy_saved_search

|Mute, block, and report use

rs|_
GET blocks/ids API.get_blocked_ids
GET blocks/list API.get_blocks
GET mutes/users/ids API.get_muted_ids
GET mutes/users/list API.get_mutes
POST blocks/create API.create_block
POST blocks/destroy API.destroy_block
POST mutes/users/create API.create_mute
POST mutes/users/destroy API.destroy_mute
POST users/report_spam API.report_spam

Direct Messages

|Sending and receiving event

s|_
DELETE direct_messages/events/destroy API.delete_direct_message
GET direct_messages/events/list API.get_direct_messages
GET direct_messages/events/show API.get_direct_message
POST direct_messages/events/new API.send_direct_message

|Typing indicator and read r

eceipts|_
POST direct_messages/indicate_typing API.indicate_direct_message_typing
POST direct_messages/mark_read API.mark_direct_message_read

Media

Upload media_

GET media/upload API.get_media_upload_status
POST media/metadata/create API.create_media_metadata
API.media_upload
POST media/upload API.simple_upload
API.chunked_upload
POST media/upload (APPEND) API.chunked_upload_append
POST media/upload (FINALIZE) API.chunked_upload_finalize
POST media/upload (INIT) API.chunked_upload_init

Trends

|Get locations with trending

topics|_
GET trends/available :meth:API.available_trends
GET trends/closest API.closest_trends

|Get trends near a location

|_
GET trends/place API.get_place_trends

:ref:Geo

|Get information about a pla

ce|_
GET geo/id/:place_id API.geo_id

|Get places near a location

|_
GET geo/reverse_geocode API.reverse_geocode
GET geo/search API.search_geo

Developer utilities

|Get Twitter supported langu

ages|_
GET help/languages API.supported_languages

Get app rate limit status_

GET application/rate_limit_status API.rate_limit_status

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

API.available_trends

API.closest_trends

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

Footnotes