@pagination(mode='next')
@payload('status', list=True)
def search_30_day(self, label, query, **kwargs):
- r"""search_30_day(label, query, *, tag, fromDate, toDate, maxResults, \
- next)
+ """search_30_day(label, query, *, tag, fromDate, toDate, maxResults, \
+ next)
Premium search that provides Tweets posted within the last 30 days.
@pagination(mode='next')
@payload('status', list=True)
def search_full_archive(self, label, query, **kwargs):
- r"""search_full_archive(label, query, *, tag, fromDate, toDate, \
- maxResults, next)
+ """search_full_archive(label, query, *, tag, fromDate, toDate, \
+ maxResults, next)
Premium search that provides Tweets from as early as 2006, starting
with the first Tweet posted in March 2006.
@pagination(mode='id')
@payload('status', list=True)
def home_timeline(self, **kwargs):
- r"""home_timeline(*, count, since_id, max_id, trim_user, \
- exclude_replies, include_entities)
+ """home_timeline(*, count, since_id, max_id, trim_user, \
+ exclude_replies, include_entities)
Returns the 20 most recent statuses, including retweets, posted by
the authenticating user and that user's friends. This is the equivalent
@pagination(mode='id')
@payload('status', list=True)
def mentions_timeline(self, **kwargs):
- r"""mentions_timeline(*, count, since_id, max_id, trim_user, \
- include_entities)
+ """mentions_timeline(*, count, since_id, max_id, trim_user, \
+ include_entities)
Returns the 20 most recent mentions, including retweets.
@pagination(mode='id')
@payload('status', list=True)
def user_timeline(self, **kwargs):
- r"""user_timeline(*, user_id, screen_name, since_id, count, max_id, \
- trim_user, exclude_replies, include_rts)
+ """user_timeline(*, user_id, screen_name, since_id, count, max_id, \
+ trim_user, exclude_replies, include_rts)
Returns the 20 most recent statuses posted from the authenticating user
or the user specified. It's also possible to request another user's
@pagination(mode='id')
@payload('status', list=True)
def get_favorites(self, **kwargs):
- r"""get_favorites(*, user_id, screen_name, count, since_id, max_id, \
- include_entities)
+ """get_favorites(*, user_id, screen_name, count, since_id, max_id, \
+ include_entities)
Returns the favorite statuses for the authenticating user or user
specified by the ID parameter.
@payload('status', list=True)
def lookup_statuses(self, id, **kwargs):
- r"""lookup_statuses(id, *, include_entities, trim_user, map, \
- include_ext_alt_text, include_card_uri)
+ """lookup_statuses(id, *, include_entities, trim_user, map, \
+ include_ext_alt_text, include_card_uri)
Returns full Tweet objects for up to 100 Tweets per request, specified
by the ``id`` parameter.
@pagination(mode='cursor')
@payload('ids')
def get_retweeter_ids(self, id, **kwargs):
- r"""get_retweeter_ids(id, *, count, cursor, stringify_ids)
+ """get_retweeter_ids(id, *, count, cursor, stringify_ids)
Returns up to 100 user IDs belonging to users who have retweeted the
Tweet specified by the ``id`` parameter.
@payload('status', list=True)
def get_retweets(self, id, **kwargs):
- r"""get_retweets(id, *, count, trim_user)
+ """get_retweets(id, *, count, trim_user)
Returns up to 100 of the first Retweets of the given Tweet.
@pagination(mode='id')
@payload('status', list=True)
def get_retweets_of_me(self, **kwargs):
- r"""get_retweets_of_me(*, count, since_id, max_id, trim_user, \
- include_entities, include_user_entities)
+ """get_retweets_of_me(*, count, since_id, max_id, trim_user, \
+ include_entities, include_user_entities)
Returns the 20 most recent Tweets of the authenticated user that have
been retweeted by others.
@pagination(mode='id')
@payload('search_results')
def search_tweets(self, q, **kwargs):
- r"""search_tweets(q, *, geocode, lang, locale, result_type, count, \
- until, since_id, max_id, include_entities)
+ """search_tweets(q, *, geocode, lang, locale, result_type, count, \
+ until, since_id, max_id, include_entities)
Returns a collection of relevant Tweets matching a specified query.
@payload('list', list=True)
def get_lists(self, **kwargs):
- r"""get_lists(*, user_id, screen_name, reverse)
+ """get_lists(*, user_id, screen_name, reverse)
Returns all lists the authenticating or specified user subscribes to,
including their own. The user is specified using the ``user_id`` or
@pagination(mode='cursor')
@payload('user', list=True)
def get_list_members(self, **kwargs):
- r"""get_list_members(*, list_id, slug, owner_screen_name, owner_id, \
- count, cursor, include_entities, skip_status)
+ """get_list_members(*, list_id, slug, owner_screen_name, owner_id, \
+ count, cursor, include_entities, skip_status)
Returns the members of the specified list.
@pagination(mode='cursor')
@payload('list', list=True)
def get_list_memberships(self, **kwargs):
- r"""get_list_memberships(*, user_id, screen_name, count, cursor, \
- filter_to_owned_lists)
+ """get_list_memberships(*, user_id, screen_name, count, cursor, \
+ filter_to_owned_lists)
Returns the lists the specified user has been added to. If ``user_id``
or ``screen_name`` are not provided, the memberships for the
@pagination(mode='cursor')
@payload('list', list=True)
def get_list_ownerships(self, **kwargs):
- r"""get_list_ownerships(*, user_id, screen_name, count, cursor)
+ """get_list_ownerships(*, user_id, screen_name, count, cursor)
Returns the lists owned by the specified user. Private lists will only
be shown if the authenticated user is also the owner of the lists. If
@pagination(mode='id')
@payload('status', list=True)
def list_timeline(self, **kwargs):
- r"""list_timeline( \
+ """list_timeline( \
*, list_id, slug, owner_screen_name, owner_id, since_id, max_id, \
count, include_entities, include_rts \
)
@pagination(mode='cursor')
@payload('user', list=True)
def get_list_subscribers(self, **kwargs):
- r"""get_list_subscribers( \
+ """get_list_subscribers( \
*, list_id, slug, owner_screen_name, owner_id, count, cursor, \
include_entities, skip_status \
)
@pagination(mode='cursor')
@payload('list', list=True)
def get_list_subscriptions(self, **kwargs):
- r"""get_list_subscriptions(*, user_id, screen_name, count, cursor)
+ """get_list_subscriptions(*, user_id, screen_name, count, cursor)
Obtain a collection of the lists the specified user is subscribed to,
20 lists per page by default. Does not include the user's own lists.
@pagination(mode='cursor')
@payload('ids')
def get_follower_ids(self, **kwargs):
- r"""get_follower_ids(*, user_id, screen_name, cursor, stringify_ids, \
- count)
+ """get_follower_ids(*, user_id, screen_name, cursor, stringify_ids, \
+ count)
Returns an array containing the IDs of users following the specified
user.
@pagination(mode='cursor')
@payload('user', list=True)
def get_followers(self, **kwargs):
- r"""get_followers(*, user_id, screen_name, cursor, count, skip_status, \
- include_user_entities)
+ """get_followers(*, user_id, screen_name, cursor, count, skip_status, \
+ include_user_entities)
Returns a user's followers ordered in which they were added. If no user
is specified by id/screen name, it defaults to the authenticated user.
@pagination(mode='cursor')
@payload('ids')
def get_friend_ids(self, **kwargs):
- r"""get_friend_ids(*, user_id, screen_name, cursor, stringify_ids, \
- count)
+ """get_friend_ids(*, user_id, screen_name, cursor, stringify_ids, \
+ count)
Returns an array containing the IDs of users being followed by the
specified user.
@pagination(mode='cursor')
@payload('user', list=True)
def get_friends(self, **kwargs):
- r"""get_friends(*, user_id, screen_name, cursor, count, skip_status, \
- include_user_entities)
+ """get_friends(*, user_id, screen_name, cursor, count, skip_status, \
+ include_user_entities)
Returns a user's friends ordered in which they were added 100 at a
time. If no user is specified it defaults to the authenticated user.
@pagination(mode='cursor')
@payload('ids')
def incoming_friendships(self, **kwargs):
- r"""incoming_friendships(*, cursor, stringify_ids)
+ """incoming_friendships(*, cursor, stringify_ids)
Returns a collection of numeric IDs for every user who has a pending
request to follow the authenticating user.
@payload('relationship', list=True)
def lookup_friendships(self, *, screen_name=None, user_id=None, **kwargs):
- r"""lookup_friendships(*, screen_name, user_id)
+ """lookup_friendships(*, screen_name, user_id)
Returns the relationships of the authenticated user to the list of up
to 100 screen_name or user_id provided.
@payload('ids')
def no_retweets_friendships(self, **kwargs):
- r"""no_retweets_friendships(*, stringify_ids)
+ """no_retweets_friendships(*, stringify_ids)
Returns a collection of user_ids that the currently authenticated user
does not want to receive retweets from.
@pagination(mode='cursor')
@payload('ids')
def outgoing_friendships(self, **kwargs):
- r"""outgoing_friendships(*, cursor, stringify_ids)
+ """outgoing_friendships(*, cursor, stringify_ids)
Returns a collection of numeric IDs for every protected user for whom
the authenticating user has a pending follow request.
@payload('user', list=True)
def lookup_users(self, *, screen_name=None, user_id=None, **kwargs):
- r"""lookup_users(*, screen_name, user_id, include_entities, tweet_mode)
+ """lookup_users(*, screen_name, user_id, include_entities, tweet_mode)
Returns fully-hydrated user objects for up to 100 users per request.
@pagination(mode='page')
@payload('user', list=True)
def search_users(self, q, **kwargs):
- r"""search_users(q, *, page, count, include_entities)
+ """search_users(q, *, page, count, include_entities)
Run a search for users similar to Find People button on Twitter.com;
the same results returned by people search on Twitter.com will be
@payload('saved_search', list=True)
def get_saved_searches(self, **kwargs):
- r"""get_saved_searches()
+ """get_saved_searches()
Returns the authenticated user's saved search queries.
@pagination(mode='cursor')
@payload('ids')
def get_blocked_ids(self, **kwargs):
- r"""get_blocked_ids(*, stringify_ids, cursor)
+ """get_blocked_ids(*, stringify_ids, cursor)
Returns an array of numeric user IDs the authenticating user is
blocking.
@pagination(mode='cursor')
@payload('user', list=True)
def get_blocks(self, **kwargs):
- r"""get_blocks(*, include_entities, skip_status, cursor)
+ """get_blocks(*, include_entities, skip_status, cursor)
Returns an array of user objects that the authenticating user is
blocking.
@pagination(mode='cursor')
@payload('ids')
def get_muted_ids(self, **kwargs):
- r"""get_muted_ids(*, stringify_ids, cursor)
+ """get_muted_ids(*, stringify_ids, cursor)
Returns an array of numeric user IDs the authenticating user has muted.
@pagination(mode='cursor')
@payload('user', list=True)
def get_mutes(self, **kwargs):
- r"""get_mutes(*, cursor, include_entities, skip_status)
+ """get_mutes(*, cursor, include_entities, skip_status)
Returns an array of user objects the authenticating user has muted.
@pagination(mode='dm_cursor')
@payload('direct_message', list=True)
def get_direct_messages(self, **kwargs):
- r"""get_direct_messages(*, count, cursor)
+ """get_direct_messages(*, count, cursor)
Returns all Direct Message events (both sent and received) within the
last 30 days. Sorted in reverse-chronological order.
@payload('place', list=True)
def reverse_geocode(self, lat, long, **kwargs):
- r"""reverse_geocode(lat, long, *, accuracy, granularity, max_results)
+ """reverse_geocode(lat, long, *, accuracy, granularity, max_results)
Given a latitude and a longitude, searches for up to 20 places that can
be used as a ``place_id`` when updating a status.
@payload('place', list=True)
def search_geo(self, **kwargs):
- r"""search_geo(*, lat, long, query, ip, granularity, max_results)
+ """search_geo(*, lat, long, query, ip, granularity, max_results)
Search for places that can be attached to a Tweet via
:func:`API.update_status`. Given a latitude and a longitude pair, an IP
projects / tweepy.git / commitdiff