tweepy.API — Twitter API v1.1 リファレンス

class tweepy.API(auth=None, *, cache=None, host='api.twitter.com', parser=None, proxy=None, retry_count=0, retry_delay=0, retry_errors=None, timeout=60, upload_host='upload.twitter.com', user_agent=None, wait_on_rate_limit=False)

Twitter API v1.1 インターフェース

Parameters
  • auth – 使用する認証ハンドラ

  • cache – GET メソッドが使われる場合に照会するキャッシュ

  • host – 一般的な REST API のホストサーバ URL

  • parser – Twitter からのレスポンスを解析するために使用する Parser のインスタンス; デフォルトでは ModelParser のインスタンス

  • proxy – Twitter への接続に使用するための HTTPS プロキシへの URL

  • retry_count – エラー発生時に再試行する回数

  • retry_delay – 接続リトライ時に待つ秒数

  • retry_errors – 接続リトライする場合の HTTP コード

  • timeout – Twitter からのレスポンスを待つ最大時間

  • upload_host – アップロードサーバの URL

  • wait_on_rate_limit – 読み込み制限の解除を自動的に待つかどうか

Raises

TypeError – If the given parser is not a Parser instance

References

https://developer.twitter.com/en/docs/api-reference-index

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 users|_

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 users|_

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 events|_

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()

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

API.available_trends()

GET trends/closest

API.closest_trends()

|Get trends near a location|_

GET trends/place

API.get_place_trends()

Geo

Get information about a place

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 languages

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(label, query, *, tag, fromDate, toDate, maxResults, next)

直近 30 日以内のツイートが対象のプレミアムサーチ.

Parameters
  • label – 検索用の Developer Environment に紐付けるラベル (大文字と小文字は区別される). 以下のページで表示できるもの. https://developer.twitter.com/en/account/environments.

  • query

    最大 1024 文字 (サンドボックス開発環境では 256 文字) の プレミアムルールまたはフィルターに相当するもの.

    このパラメータはルールまたはフィルターの全ての要素及び 全ての操作を含む必要があり, ルールの一部を他のクエリパラメータに 分割してはいけない.

  • tag

    タグを使用することで, ルールとそのマッチングデータを異なる 論理グループに分離することができる. 与えられたルールタグは ‘matching_rules’ 属性に含まれる.

    ルールタグにルール固有の UUID を与え, クライアント側で 必要なマッピングを行うことが推奨される.

  • fromDate

    The oldest UTC timestamp (from most recent 30 days) from which the Tweets will be provided. Timestamp is in minute granularity and is inclusive (i.e. 12:00 includes the 00 minute).

    Specified: Using only the fromDate with no toDate parameter will deliver results for the query going back in time from now( ) until the fromDate.

    Not Specified: If a fromDate is not specified, the API will deliver all of the results for 30 days prior to now( ) or the toDate (if specified).

    If neither the fromDate or toDate parameter is used, the API will deliver all results for the most recent 30 days, starting at the time of the request, going backwards.

  • toDate

    The latest, most recent UTC timestamp to which the Tweets will be provided. Timestamp is in minute granularity and is not inclusive (i.e. 11:59 does not include the 59th minute of the hour).

    Specified: Using only the toDate with no fromDate parameter will deliver the most recent 30 days of data prior to the toDate.

    Not Specified: If a toDate is not specified, the API will deliver all of the results from now( ) for the query going back in time to the fromDate.

    If neither the fromDate or toDate parameter is used, the API will deliver all results for the entire 30-day index, starting at the time of the request, going backwards.

  • maxResults – The maximum number of search results to be returned by a request. A number between 10 and the system limit (currently 500, 100 for Sandbox environments). By default, a request response will return 100 results.

  • next – This parameter is used to get the next ‘page’ of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.

Returns

Return type

List[Status]

References

https://developer.twitter.com/en/docs/twitter-api/premium/search-api/api-reference/premium-search

API.search_full_archive(label, query, *, tag, fromDate, toDate, maxResults, next)

2006 年の初め頃からのツイートを対象としたプレミアムサーチ. 2006 年 3 月の最初のツイートからすべて.

Parameters
  • label – The (case-sensitive) label associated with your search developer environment, as displayed at https://developer.twitter.com/en/account/environments.

  • query

    The equivalent of one premium rule/filter, with up to 1,024 characters (256 with Sandbox dev environments).

    This parameter should include ALL portions of the rule/filter, including all operators, and portions of the rule should not be separated into other parameters of the query.

  • tag

    Tags can be used to segregate rules and their matching data into different logical groups. If a rule tag is provided, the rule tag is included in the ‘matching_rules’ attribute.

    It is recommended to assign rule-specific UUIDs to rule tags and maintain desired mappings on the client side.

  • fromDate

    The oldest UTC timestamp (from most recent 30 days) from which the Tweets will be provided. Timestamp is in minute granularity and is inclusive (i.e. 12:00 includes the 00 minute).

    Specified: Using only the fromDate with no toDate parameter will deliver results for the query going back in time from now( ) until the fromDate.

    Not Specified: If a fromDate is not specified, the API will deliver all of the results for 30 days prior to now( ) or the toDate (if specified).

    If neither the fromDate or toDate parameter is used, the API will deliver all results for the most recent 30 days, starting at the time of the request, going backwards.

  • toDate

    The latest, most recent UTC timestamp to which the Tweets will be provided. Timestamp is in minute granularity and is not inclusive (i.e. 11:59 does not include the 59th minute of the hour).

    Specified: Using only the toDate with no fromDate parameter will deliver the most recent 30 days of data prior to the toDate.

    Not Specified: If a toDate is not specified, the API will deliver all of the results from now( ) for the query going back in time to the fromDate.

    If neither the fromDate or toDate parameter is used, the API will deliver all results for the entire 30-day index, starting at the time of the request, going backwards.

  • maxResults – The maximum number of search results to be returned by a request. A number between 10 and the system limit (currently 500, 100 for Sandbox environments). By default, a request response will return 100 results.

  • next – This parameter is used to get the next ‘page’ of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.

Returns

Return type

List[Status]

References

https://developer.twitter.com/en/docs/twitter-api/premium/search-api/api-reference/premium-search

ツイート

タイムラインの取得

API.home_timeline(*, count, since_id, max_id, trim_user, exclude_replies, include_entities)

20 件のもっとも最近のステータスを返す. リツイートを含む, 認証したユーザ及びそのアカウントで フォローしているユーザのツイートを返す. これはいわゆるウェブブラウザで開く /timeline/home と同じ.

Parameters
  • count – ページごとに試行して取得する結果の数.

  • since_id – 指定した ID よりも大きい (すなわち, より最新の) ツイートを返す.

  • max_id – 指定した ID よりも小さいツイート (すなわち古いツイート) 及び ID が同じツイートを返す.

  • trim_user – ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False.

  • exclude_replies – このパラメータによってリプライを含まないタイムラインを返す. exclude_repliescount パラメータを使うことでツイートが最大まで取得できるようになる. (count パラメータによる取得数はリツイートやリプライを除外する前に処理されるため)

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

Returns

Return type

List[Status]

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-home_timeline

API.mentions_timeline(*, count, since_id, max_id, trim_user, include_entities)

20 件のもっとも最近のリプライを返す. リツイートを含む.

Parameters
  • count – ページごとに試行して取得する結果の数.

  • since_id – 指定した ID よりも大きい (すなわち, より最新の) ツイートを返す.

  • max_id – 指定した ID よりも小さいツイート (すなわち古いツイート) 及び ID が同じツイートを返す.

  • trim_user – ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

Returns

Return type

List[Status]

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-mentions_timeline

API.user_timeline(*, user_id, screen_name, since_id, count, max_id, trim_user, exclude_replies, include_rts)

認証したユーザがツイートしたもっとも最近 20 件のステータスを返す. ユーザ ID を渡すことで, 任意のユーザのツイートのステータスを取得することもできる.

Parameters
  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • since_id – 指定した ID よりも大きい (すなわち, より最新の) ツイートを返す.

  • count – ページごとに試行して取得する結果の数.

  • max_id – 指定した ID よりも小さいツイート (すなわち古いツイート) 及び ID が同じツイートを返す.

  • trim_user – ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False.

  • exclude_replies – このパラメータによってリプライを含まないタイムラインを返す. exclude_repliescount パラメータを使うことでツイートが最大まで取得できるようになる. (count パラメータによる取得数はリツイートやリプライを除外する前に処理されるため)

  • include_rts – When set to false, the timeline will strip any native retweets (though they will still count toward both the maximal length of the timeline and the slice selected by the count parameter). Note: If you’re using the trim_user parameter in conjunction with include_rts, the retweets will still contain a full user object.

Returns

Return type

List[Status]

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-user_timeline

投稿, 取得, ツイートへの反応

API.get_favorites(*, user_id, screen_name, count, since_id, max_id, include_entities)

認証したユーザか, ユーザ ID で指定したユーザの「いいね」ステータスを返す.

Parameters
  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • count – ページごとに試行して取得する結果の数.

  • since_id – 指定した ID よりも大きい (すなわち, より最新の) ツイートを返す.

  • max_id – 指定した ID よりも小さいツイート (すなわち古いツイート) 及び ID が同じツイートを返す.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

Returns

Return type

List[Status]

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-favorites-list

API.lookup_statuses(id, *, include_entities, trim_user, map, include_ext_alt_text, include_card_uri)

リクエストごとに最大 100 ツイートまで, id パラメータで指定したツイートの ツイートオブジェクトを返す.

Parameters
  • id – A list of Tweet IDs to lookup, up to 100

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • trim_user – ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False.

  • map – A boolean indicating whether or not to include Tweets that cannot be shown. Defaults to False.

  • include_ext_alt_text – If alt text has been added to any attached media entities, this parameter will return an ext_alt_text value in the top-level key for the media entity.

  • include_card_uri – ツイートに広告カードが添付されており, そのカードが card_uri 値を使って指定されている場合に, 取得したツイートに card_uri 属性を含めるかどうかの真偽値.

Returns

Return type

List[Status]

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-lookup

API.get_oembed(url, *, maxwidth, hide_media, hide_thread, omit_script, align, related, lang, theme, link_color, widget_type, dnt)

Returns a single Tweet, specified by either a Tweet web URL or the Tweet ID, in an oEmbed-compatible format. The returned HTML snippet will be automatically recognized as an Embedded Tweet when Twitter’s widget JavaScript is included on the page. ツイートの URL か ツイート ID で指定したツイートを oEmbed-compatible 形式で返す. 返された HTML スニペットは Twitter ウィジェット JavaScript が ページ内にあれば, 自動的に埋め込みツイートとして認識される.

The oEmbed endpoint allows customization of the final appearance of an Embedded Tweet by setting the corresponding properties in HTML markup to be interpreted by Twitter’s JavaScript bundled with the HTML response by default. The format of the returned markup may change over time as Twitter adds new features or adjusts its Tweet representation.

The Tweet fallback markup is meant to be cached on your servers for up to the suggested cache lifetime specified in the cache_age.

Parameters
  • url – The URL of the Tweet to be embedded

  • maxwidth – The maximum width of a rendered Tweet in whole pixels. A supplied value under or over the allowed range will be returned as the minimum or maximum supported width respectively; the reset width value will be reflected in the returned width property. Note that Twitter does not support the oEmbed maxheight parameter. Tweets are fundamentally text, and are therefore of unpredictable height that cannot be scaled like an image or video. Relatedly, the oEmbed response will not provide a value for height. Implementations that need consistent heights for Tweets should refer to the hide_thread and hide_media parameters below.

  • hide_media – When set to true, "t", or 1, links in a Tweet are not expanded to photo, video, or link previews.

  • hide_thread – When set to true, "t", or 1, a collapsed version of the previous Tweet in a conversation thread will not be displayed when the requested Tweet is in reply to another Tweet.

  • omit_script – When set to true, "t", or 1, the <script> responsible for loading widgets.js will not be returned. Your webpages should include their own reference to widgets.js for use across all Twitter widgets including Embedded Tweets.

  • align – Specifies whether the embedded Tweet should be floated left, right, or center in the page relative to the parent element.

  • related – A comma-separated list of Twitter usernames related to your content. This value will be forwarded to Tweet action intents if a viewer chooses to reply, like, or retweet the embedded Tweet.

  • lang – Request returned HTML and a rendered Tweet in the specified Twitter language supported by embedded Tweets.

  • theme – When set to dark, the Tweet is displayed with light text over a dark background.

  • link_color – Adjust the color of Tweet text links with a hexadecimal color value.

  • widget_type – Set to video to return a Twitter Video embed for the given Tweet.

  • dnt – When set to true, the Tweet and its embedded page on your site are not used for purposes that include personalized suggestions and personalized ads.

Returns

JSON

Return type

dict

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-oembed

API.get_retweeter_ids(id, *, count, cursor, stringify_ids)

id で指定した特定のツイートをリツイートしたユーザの ID を返す (最大 100 件).

Parameters
  • id – ツイート (status) の ID (数値).

  • count – ページごとに試行して取得する結果の数.

  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

  • stringify_ids – ID を文字列で返すようにする.

Returns

Return type

List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-retweeters-ids

API.get_retweets(id, *, count, trim_user)

Returns up to 100 of the first Retweets of the given Tweet. 指定したツイートをリツイートした最初の 100 アカウントを返す.

Parameters
  • id – ツイート (status) の ID (数値).

  • count – ページごとに試行して取得する結果の数.

  • trim_user – ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False.

Returns

Return type

List[Status]

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-retweets-id

API.get_retweets_of_me(*, count, since_id, max_id, trim_user, include_entities, include_user_entities)

認証されたユーザのツイートのうち, 他のユーザによってリツイートされた 最新 20 件のツイートを返す.

Parameters
  • count – ページごとに試行して取得する結果の数.

  • since_id – 指定した ID よりも大きい (すなわち, より最新の) ツイートを返す.

  • max_id – 指定した ID よりも小さいツイート (すなわち古いツイート) 及び ID が同じツイートを返す.

  • trim_user – ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • include_user_entitiesFalse に設定するとユーザオブジェクトの entities ノードを含めない. デフォルトでは True.

Returns

Return type

List[Status]

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-retweets_of_me

API.get_status(id, *, trim_user, include_my_retweet, include_entities, include_ext_alt_text, include_card_uri)

ID パラメータで指定されたツイート返す.

Parameters
  • id – ツイート (status) の ID (数値).

  • trim_user – ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False.

  • include_my_retweet – 認証ユーザによってリツイートされたツイートに, リツイート元のステータス ID を含む current_user_retweet ノードの情報を 追加して返すかどうかの真偽値.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • include_ext_alt_text – If alt text has been added to any attached media entities, this parameter will return an ext_alt_text value in the top-level key for the media entity.

  • include_card_uri – ツイートに広告カードが添付されており, そのカードが card_uri 値を使って指定されている場合に, 取得したツイートに card_uri 属性を含めるかどうかの真偽値.

Returns

Return type

Status

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-show-id

API.create_favorite(id, *, include_entities)

id で指定したツイートに (認証ユーザから) 「いいね」する.

Parameters
  • id – ツイート (status) の ID (数値).

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

Returns

Return type

Status

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-favorites-create

API.destroy_favorite(id, *, include_entities)

id で指定したツイートに (認証ユーザが) 「いいね」を外す.

Parameters
  • id – ツイート (status) の ID (数値).

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

Returns

Return type

Status

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-favorites-destroy

API.destroy_status(id, *, trim_user)

id パラメータで指定したツイートを削除する. 認証ユーザがツイートを削除する権限を持っていないといけない. (自分のツイートしか削除できない)

Parameters
  • id – ツイート (status) の ID (数値).

  • trim_user – ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False.

Returns

Return type

Status

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-destroy-id

API.retweet(id, *, trim_user)

リツイートする. リツイートするツイートの ID が必要.

Parameters
  • id – ツイート (status) の ID (数値).

  • trim_user – ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False.

Returns

Return type

Status

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-retweet-id

API.unretweet(id, *, trim_user)

リツイートを取り消す. リツイートを取り消すツイートの ID が必要.

Parameters
  • id – ツイート (status) の ID (数値).

  • trim_user – ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False.

Returns

Return type

Status

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-unretweet-id

API.update_status(status, *, in_reply_to_status_id, auto_populate_reply_metadata, exclude_reply_user_ids, attachment_url, media_ids, possibly_sensitive, lat, long, place_id, display_coordinates, trim_user, card_uri)

認証されたユーザのステータスを更新する. すなわちツイートする.

ステータス更新 (ツイート) を試みるたびに, ツイート内容は最近のツイート内容と比較される. 内容が重複するようなものはブロックされ, 403 エラーが返ってくる. ユーザは同じ内容を 2 回連続で投稿することはできない.

API では制限されていないが, ユーザが一度に作成できるツイートの数は限られている. 投稿数が現在の許容範囲に到達した場合, 403 エラーが返ってくる.

Parameters
  • status – 投稿したい内容のテキスト.

  • in_reply_to_status_id – リプライを送る先のツイートの ID. (注意: ツイート内容の status の中でリプライ先のツイートの アカウントについて言及していないと, このパラメータは無視されます. したがって status の中に @username (リプライ先のアカウント) を 含める必要がある. )

  • auto_populate_reply_metadatain_reply_to_status_id が指定されている場合に True に設定されていると 元のツイートの @メンション を追加してツイートする. これによって @メンション の上限に達するまで ツイートのメタデータに @メンションが追加され, リプライツリーが大きくなる. 元のツイートが削除されているとリプライは失敗する.

  • exclude_reply_user_idsauto_populate_reply_metadata と一緒に使われると ツイートに Twitter サーバが付ける @メンション のうち 除外したいユーザ ID のカンマ区切りリストを指定する. 先頭の @メンションは in-reply-to-status-id と 整合がとれなくなってしまうことになるので除外できない. 先頭の @メンションを除外しようとするとエラーなしに無視される.

  • attachment_url – ツイート内容の文字カウントに URL が含まれないようにするために URL をツイート添付の下腿で与える必要がある. この URL はツイートへのパーマリンクか ダイレクトメッセージへのディープリンクである必要がある. attachment_url に渡された URL がツイートへのパーマリンクでも ダイレクトメッセージへのディープリンクのいずれでもない場合, 例外が発生してツイートは失敗する.

  • media_ids – ツイートに紐付けるメディアの media_ids のリスト. 写真は最大 4 点, アニメーション GIF または動画は 1 点のみツイートに含められる.

  • possibly_sensitive – ツイートするメディアがセンシティブな内容を含むもの (ヌードやグロテスクなど) である場合は True を設定する.

  • lat – ツイートした場所の緯度. このパラメータは -90.0 から +90.0 の間 (正数は北緯) でないと無視される. また対応する long パラメータがない場合も無視される.

  • long – ツイートした場所の経度. このパラメータは -180.0 から +180.0 の間 (正数は東経) でないと無視される. 数値でない場合, geo_enabled が disable のとき, もしくは対応する lat パラメータがない場合も無視される.

  • place_id – 世界における場所の ID.

  • display_coordinates – ツイートが発信された正確な座標にピンを立てるかどうか.

  • trim_user – ユーザオブジェクト全体の代わりに, ユーザ ID を返すかどうかの真偽値. デフォルトでは False.

  • card_uri – 広告カードレスポンスにある card_uri 値を用いることで ツイートに広告カードを紐付ける.

Returns

Return type

Status

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-update

API.update_status_with_media(status, filename, *, file, possibly_sensitive, in_reply_to_status_id, lat, long, place_id, display_coordinates)

Deprecated since version 3.7.0: 非推奨 : 代わりに API.media_upload() を使用すること.

認証されたユーザのツイートをする. 同じ内容の投稿や長過ぎる投稿は無視される.

Parameters
  • status – 投稿したい内容のテキスト.

  • filename – アップロードするメディアのファイル名. file オブジェクトが指定されていない場合, 自動的にファイルオープンされる.

  • filefilename を開くときに使用されるファイルオブジェクト. MIME タイプ検出と POST データのために filename は必要.

  • possibly_sensitive – ツイートするメディアがセンシティブな内容を含むもの (ヌードやグロテスクなど) である場合は True を設定する.

  • in_reply_to_status_id – リプライしたいツイートへの ID.

  • lat – ツイートした場所の緯度.

  • long – ツイートした場所の経度.

  • place_id – ユーザが位置情報を有効にしている場合に, ツイートに載る位置情報の ID.

  • display_coordinates – ツイートが発信された正確な座標にピンを立てるかどうか.

Returns

Return type

Status

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-update_with_media

ツイート検索

API.search_tweets(q, *, geocode, lang, locale, result_type, count, until, since_id, max_id, include_entities)

指定されたクエリにマッチするツイートのコレクションを返す.

Twitter の検索サービス, すなわち検索 API はツイートを 網羅するわけではないことに注意する. 全てのツイートが検索データベースにインデックスされている (登録されている) わけではなく, 検索インターフェースで全て利用できるわけではない.

API v1.1 では検索 API のレスポンスが改善され, REST API や Twitter プラットフォームで得られるオブジェクトと 近いツイートオブジェクトを返すようになっている. ただし, このエンドポイントでは perspectival 属性 (認証したユーザの視点に関連する属性) は現在サポートされていない. 12

Parameters
  • q – 検索コマンドを含んで最大 500 文字までの検索クエリ. クエリの複雑さによってはさらに背言されることもある.

  • geocode – 与えた緯度 / 経度から指定された範囲内におけるユーザのツイートを返す. 位置情報は Geotagging API から優先的に取得されるが, ツイッタープロフィールに戻される. パラメータ値は “緯度,経度,半径” で指定され, 「半径」は “mi” (マイル) か “km” (キロメートル) のどちらかの 単位をつける必要がある. なお, API の near 演算子を使って任意の場所を geocode にすることはできないが, この geocode パラメータを使って近くの geocode を直接検索することはできる. 「半径」の修飾子を使う場合には, 最大 1,000 までの「サブ地域」が考慮される.

  • lang – ISO 639-1 形式で与えた「言語」に検索対象を制限する. 言語検出はベストエフォートでしかない.

  • locale – 送信するクエリの言語を指定する (現在有効なのは ja のみ). これは言語固有の利用者を想定したものであり, 大半の場合はデフォルトで動作する.

  • result_type

    受け取りたい検索結果のタイプを指定する. 現在のデフォルトは “mixed” である. 有効な値は以下のとおり:

    • mixed : 話題のツイートとリアルタイムの検索結果の療法を含む

    • recent : 最新の検索結果のみ

    • popular : 話題のツイートのみ

  • count – ページごとに試行して取得する結果の数.

  • until – 与えた日付より前のツイートだけを返す. 日付じは YYYY-MM-DD のフォーマットで指定する必要がある. 検索インデックスは 7 日制限があることを意識する必要がある. すなわち, 1 週間前のツイートは検索することができない.

  • since_id – 指定した ID よりも大きい (すなわち, より最新の) ツイートを返す. API を通じて取得できるツイートの数には制限がある. もし since_id より以降でツイートの取得制限に引っかかった場合, since_id は利用できるもっとも古い ID に変更される.

  • max_id – 指定した ID よりも小さいツイート (すなわち古いツイート) 及び ID が同じツイートを返す.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

Returns

Return type

SearchResults

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/search/api-reference/get-search-tweets

アカウントとユーザ

リストの作成と管理

API.get_lists(*, user_id, screen_name, reverse)

認証されたユーザか指定したユーザがフォローしているリストを返す (自分のリストを含む). ユーザの指定は user_id もしくは screen_name パラメータで行う. もしユーザが見つからなければ, 認証ユーザに対して実行される.

このメソッドでは最大 100 件までのリストが返ってくる. フォローしているリストが最初に返され, 次に自分で作成したリストが返される. つまり, あるユーザが 90 件のリストをフォローしており, 20 件のリストを作成している場合, このメソッドは 90 件のフォローしているリストと 10 件の作成したリストを返す. reverse=true の場合は作成したリストを先に返すので, 20 件の作成したリストと 80 件のフォローしているリストを返す.

Parameters
  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • reverse – 作成したリストを先に返すかどうかを示す真偽値. 詳細は上記説明を参照.

Returns

Return type

List[List]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-list

API.get_list_members(*, list_id, slug, owner_screen_name, owner_id, count, cursor, include_entities, skip_status)

指定したリストのメンバーを返す.

Parameters
  • list_id – リストの ID (数値).

  • slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

  • owner_id – The user ID of the user who owns the list being requested by a slug.

  • count – ページごとに試行して取得する結果の数.

  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • skip_status – 返されたユーザオブジェクトにステータスが含まれないかどうかを示す真偽値. デフォルトでは False.

Returns

Return type

List[User]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-members

API.get_list_member(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id, include_entities, skip_status)

指定したユーザが指定したリストのメンバーかどうか調べる.

Parameters
  • list_id – リストの ID (数値).

  • slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

  • owner_id – The user ID of the user who owns the list being requested by a slug.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • skip_status – 返されたユーザオブジェクトにステータスが含まれないかどうかを示す真偽値. デフォルトでは False.

Raises

NotFound – The user is not a member of the list.

Returns

Return type

User

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-members-show

API.get_list_memberships(*, user_id, screen_name, count, cursor, filter_to_owned_lists)

指定したユーザがメンバーになっているリストを返す. user_idscreen_name が指定されていない場合, 認証したユーザがメンバーになっているリストを返す.

Parameters
  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • count – ページごとに試行して取得する結果の数.

  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

  • filter_to_owned_lists – 認証したユーザが作成し, user_idscreen_name で 指定されたユーザがメンバーとなっているリストだけを 返すかどうかを示す真偽値.

Returns

Return type

List[List]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-memberships

API.get_list_ownerships(*, user_id, screen_name, count, cursor)

指定したユーザが作成したリストを返す. プライベートリストは認証したユーザとの共同リストの場合のみ返ってくる. もし user_id または screen_name が指定されてなければ 認証したユーザが作成したリストが返る.

Parameters
  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • count – ページごとに試行して取得する結果の数.

  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

Returns

Return type

List[List]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships

API.get_list(*, list_id, slug, owner_screen_name, owner_id)

指定したリストを返す. プライベートリストは認証したユーザが作成したリストの場合のみ返される.

Parameters
  • list_id – リストの ID (数値).

  • slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

  • owner_id – The user ID of the user who owns the list being requested by a slug.

Returns

Return type

List

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-show

API.list_timeline(*, list_id, slug, owner_screen_name, owner_id, since_id, max_id, count, include_entities, include_rts)

指定したリストのメンバーが投稿したツイートタイムラインが返ってくる. デフォルトではリツイートも含まれる. include_rts=false パラメータを指定するとリツイートは省略される.

Parameters
  • list_id – リストの ID (数値).

  • slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

  • owner_id – The user ID of the user who owns the list being requested by a slug.

  • since_id – 指定した ID よりも大きい (すなわち, より最新の) ツイートを返す.

  • max_id – 指定した ID よりも小さいツイート (すなわち古いツイート) 及び ID が同じツイートを返す.

  • count – ページごとに試行して取得する結果の数.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • include_rts – リストのタイムラインに通常のツイートに加えて, (もしあれば) リツイートを含めるかどうかの真偽値. リツイートされたツイートの出力形式は home_timeline で 表示されるものと同じ.

Returns

Return type

List[Status]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-statuses

API.get_list_subscribers(*, list_id, slug, owner_screen_name, owner_id, count, cursor, include_entities, skip_status)

指定したリストのフォロワーを返す. プライベートリストのフォロワーは認証したユーザが指定したリストの 所有者である場合のみ表示される.

Parameters
  • list_id – リストの ID (数値).

  • slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

  • owner_id – The user ID of the user who owns the list being requested by a slug.

  • count – ページごとに試行して取得する結果の数.

  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • skip_status – 返されたユーザオブジェクトにステータスが含まれないかどうかを示す真偽値. デフォルトでは False.

Returns

Return type

List[User]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-subscribers

API.get_list_subscriber(*, owner_screen_name, owner_id, list_id, slug, user_id, screen_name, include_entities, skip_status)

指定したユーザが指定したリストのフォロワーかどうか調べる.

Parameters
  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

  • owner_id – The user ID of the user who owns the list being requested by a slug.

  • list_id – リストの ID (数値).

  • slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • skip_status – 返されたユーザオブジェクトにステータスが含まれないかどうかを示す真偽値. デフォルトでは False.

Raises

NotFound – The user is not a subscriber of the list.

Returns

Return type

User

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-subscribers-show

API.get_list_subscriptions(*, user_id, screen_name, count, cursor)

指定したユーザがフォローしているリストのコレクションが得られる. デフォルトでは 1 ページあたり 20 件のリストが得られる. 指定したユーザ自身が作成したリストは含まれない.

Parameters
  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • count – ページごとに試行して取得する結果の数.

  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

Returns

Return type

List[List]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-subscriptions

API.create_list(name, *, mode, description)

認証したユーザによる新しいリストを作成する. アカウントごとに最大 1,000 件までしかリストが作成できないことに注意.

Parameters
  • name – 新しいリストの名前.

  • mode – リストを公開にするか非公開にするかどうか. 値は public または private. 特に指定しないとデフォルトでは公開リストになる.

  • description – 作成するリストの説明.

Returns

Return type

List

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-create

API.destroy_list(*, owner_screen_name, owner_id, list_id, slug)

指定したリストを削除する. 認証したユーザが作成したリストでないと削除することはできない.

Parameters
  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

  • owner_id – The user ID of the user who owns the list being requested by a slug.

  • list_id – リストの ID (数値).

  • slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

Returns

Return type

List

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy

API.add_list_member(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)

リストに新しいメンバーを追加する. 認証したユーザが作成したリストでないとメンバーを追加できない. リストのメンバーは最大 5,000 件.

Parameters
  • list_id – リストの ID (数値).

  • slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

  • owner_id – The user ID of the user who owns the list being requested by a slug.

Returns

Return type

List

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create

API.add_list_members(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)

リストに最大 100 アカウントまでメンバーを追加する. 認証したユーザが作成したリストでないとメンバーを追加できない. リストのメンバーは最大 5,000 件.

Parameters
  • list_id – リストの ID (数値).

  • slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

  • user_id – カンマ区切りのユーザ ID リスト. 1 度のリクエストあたり 100 件まで.

  • screen_name – カンマ区切りのスクリーンネームのリスト. 1 度のリクエストあたり 100 件まで.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

  • owner_id – The user ID of the user who owns the list being requested by a slug.

Returns

Return type

List

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create_all

API.remove_list_member(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)

指定したメンバーをリストから除外する. 認証したユーザが作成したリストでないとメンバーを除外できない.

Parameters
  • list_id – リストの ID (数値).

  • slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

  • owner_id – The user ID of the user who owns the list being requested by a slug.

Returns

Return type

List

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy

API.remove_list_members(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)

リストから最大 100 アカウントまでメンバーを除外する. 認証したユーザが作成したリストでないとメンバーを除外できない. リストのメンバーは最大 5,000 件.

Parameters
  • list_id – リストの ID (数値).

  • slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

  • user_id – カンマ区切りのユーザ ID リスト. 1 度のリクエストあたり 100 件まで.

  • screen_name – カンマ区切りのスクリーンネームのリスト. 1 度のリクエストあたり 100 件まで.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

  • owner_id – The user ID of the user who owns the list being requested by a slug.

Returns

Return type

List

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy_all

API.subscribe_list(*, owner_screen_name, owner_id, list_id, slug)

指定したリストを認証したユーザでフォローする.

Parameters
  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

  • owner_id – The user ID of the user who owns the list being requested by a slug.

  • list_id – リストの ID (数値).

  • slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

Returns

Return type

List

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-subscribers-create

API.unsubscribe_list(*, list_id, slug, owner_screen_name, owner_id)

指定したリストの認証したユーザでのフォローを外す.

Parameters
  • list_id – リストの ID (数値).

  • slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

  • owner_id – The user ID of the user who owns the list being requested by a slug.

Returns

Return type

List

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-subscribers-destroy

API.update_list(*, list_id, slug, name, mode, description, owner_screen_name, owner_id)

指定したリストを更新, 変更する. 認証したユーザが作成したリストでないと変更できない.

Parameters
  • list_id – リストの ID (数値).

  • slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

  • name – リストの名前.

  • mode – リストを公開にするか非公開にするかどうか. 値は public または private. 特に指定しないとデフォルトでは公開リストになる.

  • description – リストの説明.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

  • owner_id – The user ID of the user who owns the list being requested by a slug.

Returns

Return type

List

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-update

フォロー, 検索, おすすめユーザー

API.get_follower_ids(*, user_id, screen_name, cursor, stringify_ids, count)

指定したユーザをフォローしているユーザのユーザ ID を含む配列を返す.

Parameters
  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

  • stringify_ids – ID を文字列で返すようにする.

  • count – ページごとに試行して取得する結果の数.

Returns

Return type

List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids

API.get_followers(*, user_id, screen_name, cursor, count, skip_status, include_user_entities)

指定したユーザのフォロワーをフォローした順で返す. user_idscreen_name も指定されなければ, デフォルトでは認証したユーザのフォロワーについて返す.

Parameters
  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

  • count – ページごとに試行して取得する結果の数.

  • skip_status – 返されたユーザオブジェクトにステータスが含まれないかどうかを示す真偽値. デフォルトでは False.

  • include_user_entitiesFalse に設定するとユーザオブジェクトの entities ノードを含めない. デフォルトでは True.

Returns

Return type

List[User]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-followers-list

API.get_friend_ids(*, user_id, screen_name, cursor, stringify_ids, count)

指定したユーザがフォローしているユーザのユーザ ID を含む配列を返す.

Parameters
  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

  • stringify_ids – ID を文字列で返すようにする.

  • count – ページごとに試行して取得する結果の数.

Returns

Return type

List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids

API.get_friends(*, user_id, screen_name, cursor, count, skip_status, include_user_entities)

指定したユーザがフォローしているユーザを追加した順で 1 回あたり 100 件まで返す. もしユーザが指定されていないと, デフォルトでは認証したユーザに対して実行する.

Parameters
  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

  • count – ページごとに試行して取得する結果の数.

  • skip_status – 返されたユーザオブジェクトにステータスが含まれないかどうかを示す真偽値. デフォルトでは False.

  • include_user_entitiesFalse に設定するとユーザオブジェクトの entities ノードを含めない. デフォルトでは True.

Returns

Return type

List[User]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friends-list

API.incoming_friendships(*, cursor, stringify_ids)

認証したユーザにフォローリクエスト送った全てのユーザの ユーザ ID (数値) コレクションを返す.

Parameters
  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

  • stringify_ids – ID を文字列で返すようにする.

Returns

Return type

List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming

API.lookup_friendships(*, screen_name, user_id)

認証したユーザと 1 回あたり 100 件までの 指定した screen_name または user_id のユーザとの フォロー・フォロワー・フォローリクエストの情報を返す.

Parameters
  • screen_name – スクリーンネームのリスト. 1 度のリクエストあたり 100 件まで.

  • user_id – ユーザ ID のリスト. 1 度のリクエストあたり 100 件まで.

Returns

Return type

List[Relationship]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-lookup

API.no_retweets_friendships(*, stringify_ids)

認証したユーザがリツイートを表示しないように指定しているユーザの user_ids コレクションを返す.

Parameters

stringify_ids – ID を文字列で返すようにする.

Returns

Return type

List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-no_retweets-ids

API.outgoing_friendships(*, cursor, stringify_ids)

認証したユーザがフォローリクエストを保留している 全ての非公開アカウントのユーザ ID (数値) のコレクションを返す.

Parameters
  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

  • stringify_ids – ID を文字列で返すようにする.

Returns

Return type

List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-outgoing

API.get_friendship(*, source_id, source_screen_name, target_id, target_screen_name)

指定した 2 つのユーザの間における フォロー・フォロワー・フォローリクエストの情報を返す.

Parameters
  • source_id – 主体となるユーザの user_id.

  • source_screen_name – 主体となるユーザの screen_name.

  • target_id – ターゲットユーザの user_id.

  • target_screen_name – ターゲットユーザの screen_name.

Returns

Return type

Friendship

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-show

API.lookup_users(*, screen_name, user_id, include_entities, tweet_mode)

1 度のリクエストにつき 100 件まで, 指定されたユーザの全ての情報を返す.

このメソッドを使うときのいくつかの注意事項は以下のとおり.

  • 非公開ユーザの最近の投稿を表示するためには, フォローしている必要がある. 非公開ユーザをフォローしていない場合, 投稿は表示されない.

  • ユーザ ID やスクリーンネームの順番は, 返ってくる配列で順番が一致しない場合がある.

  • リクエストしたユーザが見つからない, 凍結されている, 削除されている場合は返り値のリストには含まれない.

  • 返ってきたユーザオブジェクトにおいて検索条件が満たされない場合, HTTP 404 エラーが投げられる.

Parameters
  • screen_name – スクリーンネームのリスト. 1 度のリクエストあたり 100 件まで.

  • user_id – ユーザ ID のリスト. 1 度のリクエストあたり 100 件まで.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • tweet_mode – 使用できるリクエストは compat または extended で, 互換モード (compatibility mode) と拡張モード (extended mode) に対応する. それぞれ 140 文字を超えるツイートに対して作用する.

Returns

Return type

List[User]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup

API.search_users(q, *, page, count, include_entities)

Twitter.com における「友達をさがす」と同様のユーザ検索を実行する. Twitter.com の「友達をさがす」と同じ結果がこの API でも返ってくる. この API では最初の 1,000 件までしか検索できない.

Parameters
  • q – 「友達を探す」に対して実行するクエリ.

  • page – Specifies the page of results to retrieve. Note: there are pagination limits.

  • count – ページごとに試行して取得する結果の数.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

Returns

Return type

List[User]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-users-search

API.get_user(*, user_id, screen_name, include_entities)

指定したユーザに関する情報を返す.

Parameters
  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

Returns

Return type

User

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-users-show

API.create_friendship(*, screen_name, user_id, follow)

指定したユーザを新しくフォローする.

Parameters
  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • follow – フォローするだけでなく, 当該ユーザのツイート通知もオンにする.

Returns

Return type

User

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/post-friendships-create

API.destroy_friendship(*, screen_name, user_id)

指定したユーザのフォローを外す.

Parameters
  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

Returns

Return type

User

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy

API.update_friendship(*, screen_name, user_id, device, retweets)

指定したユーザのリツイート通知およびデバイス通知のオンオフを切り替える.

Parameters
  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • device – 指定したユーザのデバイス通知のオンオフを切り替える.

  • retweets – 指定したユーザのリツイート通知のオンオフを切り替える.

Returns

Return type

Friendship

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update

アカウントの設定とプロフィール

API.get_settings()

認証したユーザの設定を返す (現在地, 通知のスリープ状態なども含まれる).

Returns

JSON

Return type

dict

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-account-settings

API.verify_credentials(*, include_entities, skip_status, include_email)

与えた認証情報が有効であることを確認する.

Parameters
  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • skip_status – 返されたユーザオブジェクトにステータスが含まれないかどうかを示す真偽値. デフォルトでは False.

  • include_emailTrue に設定するとユーザオブジェクトの中に文字列として メールアドレスを含めて返す.

Raises

Unauthorized – Authentication unsuccessful

Returns

Return type

User

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials

API.get_saved_searches()

認証したユーザの「保存した検索」を返す.

Returns

Return type

List[SavedSearch]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list

認証したユーザによる「保存した検索」のうち, ID で与えられたもののデータを取得する.

Parameters

id – 取得したい「保存した検索」の ID.

Returns

Return type

SavedSearch

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-show-id

API.get_profile_banner(*, user_id, screen_name)

指定したユーザのプロフィールヘッダー画像を利用可能な様々なサイズ別の map を返す. もしユーザがプロフィールヘッダー画像を設定していない場合, HTTP 404 エラーが返ってくる.

各サイズ別に取得できるプロフィールヘッダー画像の URL は PNG 形式のデータとなる.

Parameters
  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

Returns

JSON

Return type

dict

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-users-profile_banner

API.remove_profile_banner()

認証したユーザのプロフィールヘッダー画像を削除する.

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-remove_profile_banner

API.set_settings(*, sleep_time_enabled, start_sleep_time, end_sleep_time, time_zone, trend_location_woeid, lang)

認証したユーザの設定を更新する.

Parameters
  • sleep_time_enabled – When set to true, t or 1 , will enable sleep time for the user. Sleep time is the time when push or SMS notifications should not be sent to the user. true または t または 1 に設定するとスリープタイムを有効にする. スリープタイムはプッシュ通知や SMS 通知を送らない時間.

  • start_sleep_time – スリープ機能をオンのときにスリープを有効にする時刻. このパラメータの値は ISO 8601 形式 (例: 00-23) で与える必要がある. 時刻はユーザの time_zone 設定と同じタイムゾーンで扱われる.

  • end_sleep_time – スリープ機能をオンのときにスリープを無効にする時刻. このパラメータの値は ISO 8601 形式 (例: 00-23) で与える必要がある. 時刻はユーザの time_zone 設定と同じタイムゾーンで扱われる.

  • time_zone – ユーザに表示される日付時刻のタイムゾーン. タイムゾーンは Rails TimeZone の名称を用いる.

  • trend_location_woeid – ユーザのデフォルトのトレンドに使われる場所の Yahoo! WOEID (Where On Earth ID). WOEID に 1 を設定するとグローバルトレンドが得られる.

  • lang – ユーザの Twitter 表示に使う言語. 言語は ISO 639-1 形式の 2 文字で指定する必要がある.

Returns

JSON

Return type

dict

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-settings

API.update_profile(*, name, url, location, description, profile_link_color, include_entities, skip_status)

ユーザがプロフィールで設定可能な値を設定する.

Parameters
  • name – プロフィールに設定されている名前.

  • url – プロフィールに設定されているウェブサイトの URL. http:// がない場合は, 先頭に追加される.

  • location – ユーザアカウントの都市や国などの位置情報. この内容はジオコードなどで正規化されることはない.

  • description – A description of the user owning the account. ユーザプロフィールに設定されている自己紹介の内容.

  • profile_link_color – 認証したユーザの twitter.com におけるプロフィールページで 使用されるリンクの色を指定する 16 進数の値を設定する. この値は有効な 16 進数である必要があり, 3 文字または 6 文字のいずれか. (例: F00 または FF0000)

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • skip_status – 返されたユーザオブジェクトにステータスが含まれないかどうかを示す真偽値. デフォルトでは False.

Returns

Return type

User

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile

API.update_profile_banner(filename, *, file, width, height, offset_left, offset_top)

認証したユーザの代わりにプロフィールヘッダー画像をアップロードする.

Parameters
  • filename – アップロードするメディアのファイル名. file オブジェクトが指定されていない場合, 自動的にファイルオープンされる.

  • filefilename を開くときに使用されるファイルオブジェクト. MIME タイプ検出と POST データのために filename は必要.

  • width – The width of the preferred section of the image being uploaded in pixels. Use with height, offset_left, and offset_top to select the desired region of the image to use.

  • height – The height of the preferred section of the image being uploaded in pixels. Use with width, offset_left, and offset_top to select the desired region of the image to use.

  • offset_left – The number of pixels by which to offset the uploaded image from the left. Use with height, width, and offset_top to select the desired region of the image to use.

  • offset_top – The number of pixels by which to offset the uploaded image from the top. Use with height, width, and offset_left to select the desired region of the image to use.

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_banner

API.update_profile_image(filename, *, file, include_entities, skip_status)

Update the authenticating user’s profile image. Valid formats: GIF, JPG, or PNG 認証したユーザのプロフィール画像を更新する. 使える画像フォーマットは GIF, JPG, PNG.

Parameters
  • filename – アップロードするメディアのファイル名. file オブジェクトが指定されていない場合, 自動的にファイルオープンされる.

  • filefilename を開くときに使用されるファイルオブジェクト. MIME タイプ検出と POST データのために filename は必要.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • skip_status – 返されたユーザオブジェクトにステータスが含まれないかどうかを示す真偽値. デフォルトでは False.

Returns

Return type

User

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image

認証したユーザの「保存した検索」を新たに増やす.

Parameters

query – 保存したい検索クエリ.

Returns

Return type

SavedSearch

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-create

認証したユーザの「保存した検索」を削除する. 「保存した検索」は ID で指定し, 認証したユーザの設定である必要がある.

Parameters

id – 削除したい「保存した検索」の ID.

Returns

Return type

SavedSearch

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-destroy-id

ミュート, ブロック, ユーザーの報告

API.get_blocked_ids(*, stringify_ids, cursor)

認証したユーザがブロックしたユーザのユーザ ID (数値) 配列を返す.

Parameters
  • stringify_ids – ID を文字列で返すようにする.

  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

Returns

Return type

List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-blocks-ids

API.get_blocks(*, include_entities, skip_status, cursor)

認証したユーザがブロックしたユーザのユーザオブジェクトの配列を返す.

Parameters
  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • skip_status – 返されたユーザオブジェクトにステータスが含まれないかどうかを示す真偽値. デフォルトでは False.

  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

Returns

Return type

List[User]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list

API.get_muted_ids(*, stringify_ids, cursor)

認証したユーザがミュートしたユーザのユーザ ID (数値) 配列を返す.

Parameters
  • stringify_ids – ID を文字列で返すようにする.

  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

Returns

Return type

List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-mutes-users-ids

API.get_mutes(*, cursor, include_entities, skip_status)

認証したユーザがミュートしたユーザのユーザオブジェクトの配列を返す.

Parameters
  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • skip_status – 返されたユーザオブジェクトにステータスが含まれないかどうかを示す真偽値. デフォルトでは False.

Returns

Return type

List[User]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-mutes-users-list

API.create_block(*, screen_name, user_id, include_entities, skip_status)

指定したユーザが認証したユーザをフォローできないようにブロックする. ブロックしたユーザは認証したユーザのメンションやタイムラインに 現れることはなくなる (他のユーザがリツイートした場合は除く). もしフォローやフォロワーで会った場合は解除される.

Parameters
  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • skip_status – 返されたユーザオブジェクトにステータスが含まれないかどうかを示す真偽値. デフォルトでは False.

Returns

Return type

User

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-blocks-create

API.destroy_block(*, screen_name, user_id, include_entities, skip_status)

ID パラメータで指定したユーザの認証したユーザによるブロックを解く.

Parameters
  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • include_entitiesFalse に設定すると entities ノードを含めない. デフォルトでは True.

  • skip_status – 返されたユーザオブジェクトにステータスが含まれないかどうかを示す真偽値. デフォルトでは False.

Returns

Return type

User

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-blocks-destroy

API.create_mute(*, screen_name, user_id)

ID パラメータで指定したユーザを認証したユーザでミュートする.

Parameters
  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

Returns

Return type

User

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-create

API.destroy_mute(*, screen_name, user_id)

ID パラメータで指定したユーザの認証したユーザによるミュートを解く.

Parameters
  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

Returns

Return type

User

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-destroy

API.report_spam(*, screen_name, user_id, perform_block)

指定したユーザをスパムアカウントとして Twitter に報告する.

Parameters
  • screen_name – ユーザのスクリーンネームの指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • user_id – ユーザ ID の指定. スクリーンネームとユーザ ID が被っているような場合に曖昧さをなくすために役立つ.

  • perform_block – 報告したアカウントをブロックするかどうかを示す真偽値. デフォルトでは True.

Returns

Return type

User

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-users-report_spam

ダイレクトメッセージ

DM の送信及び受信

API.delete_direct_message(id)

ID パラメータで指定したダイレクトメッセージ (DM) を削除する. 認証したユーザは指定した DM の受信者である必要がある. DM はユーザインターフェースから見えなくなるだけで 会話に参加している他のメンバーからは DM の内容を見ることができる.

Parameters

id – 削除したい DM の ID.

References

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/delete-message-event

API.get_direct_messages(*, count, cursor)

最近 30 日間の全てのダイレクトメッセージのイベント (送信及び受信) を返す. 時間逆順にソートされている.

Parameters
  • count – ページごとに試行して取得する結果の数.

  • cursor – 結果をページに分けて出力する. ページングの開始には -1 を与える. 返り値に含まれる next_cursor 属性と previous_cursor 属性の値を利用してリストの前後にページを移動する.

Returns

Return type

List[DirectMessage]

References

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/list-events

API.get_direct_message(id)

指定したダイレクトメッセージを返す.

Parameters

id – 取得したいダイレクトメッセージのイベントの ID.

Returns

Return type

DirectMessage

References

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/get-event

API.send_direct_message(recipient_id, text, *, quick_reply_options, attachment_type, attachment_media_id, ctas)

認証したユーザから指定したユーザへ新しくダイレクトメッセージ (DM) を送る.

Parameters
  • recipient_id – DM 送信先ユーザの ID.

  • text – DM の内容. 最大 10,000 文字.

  • quick_reply_options – オプションオブジェクトの配列 (最大 20).

  • attachment_type – 添付形式. メディアまたは位置情報.

  • attachment_media_id – DM に添付するメディアの ID. DM は 1 つの media_id だけ参照できる.

  • ctas – 1 から 3 の call-to-action (CTA) ボタンオブジェクト配列.

Returns

Return type

DirectMessage

References

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/new-event

メディア

メディアアップロード

API.get_media_upload_status(media_id)

複数メディアのアップロード進行状況を確認する. もしアップロードが成功していれば, media_id を使って 画像つきツイートを作成できる.

Parameters

media_id – 確認したいメディアの ID.

Returns

Return type

Media

References

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/get-media-upload-status

API.create_media_metadata(media_id, alt_text)

このメソッドはアップロードした media_id のメディアに 追加情報を与えることができる. この機能は現在, 画像ファイルと GIF ファイルがサポートされている. これを呼び出すことで画像の代替テキスト (alt 要素) などを追加できる.

Parameters
  • media_id – alt テキストを追加したいメディアの ID.

  • alt_text – 画像に追加したい alt テキスト.

References

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-metadata-create

API.media_upload(filename, *, file, chunked, media_category, additional_owners)

Twitter にメディアをアップロードする際に使用する. これは API.simple_upload()API.chunked_upload() を 呼ぶことになる. API.chunked_upload() は動画のアップロード時に自動的に使用される. もし chunked が設定されているか, メディアが動画であった場合, API.chunked_upload() にキーワード引数として wait_for_async_finalize を指定することができる.

Parameters
  • filename – アップロードするメディアのファイル名. file オブジェクトが指定されていない場合, 自動的にファイルオープンされる.

  • filefilename を開くときに使用されるファイルオブジェクト. MIME タイプ検出と POST データのために filename は必要.

  • chunked – chunked media upload (複数メディアアップロード用メソッド) を使用するかどうかのフラグ. デフォルトでは False.

  • media_category – メディアがどのように利用されるかを示すカテゴリ. この項目は Ads API でメディアを利用する際に必要となる.

  • additional_owners – 画像などの media_id をツイートや Twitter カードで共有するユーザ ID のリスト. 最大 100 アカウントまで共有できる.

Returns

Return type

Media

References

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/overview

API.simple_upload(filename, *, file, media_category, additional_owners)

メディアを Twitter にアップロードする際はこの関数を使用する. この場合は chunked アップロード (複数ファイルのアップロード) を使用しない.

Parameters
  • filename – アップロードするメディアのファイル名. file オブジェクトが指定されていない場合, 自動的にファイルオープンされる.

  • filefilename を開くときに使用されるファイルオブジェクト. MIME タイプ検出と POST データのために filename は必要.

  • media_category – メディアがどのように利用されるかを示すカテゴリ. この項目は Ads API でメディアを利用する際に必要となる.

  • additional_owners – 画像などの media_id をツイートや Twitter カードで共有するユーザ ID のリスト. 最大 100 アカウントまで共有できる.

Returns

Return type

Media

References

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload

API.chunked_upload(filename, *, file, file_type, wait_for_async_finalize, media_category, additional_owners)

メディアを Twitter にアップロードする際はこの関数を使用する. この関数はチャンクアップロードエンドポイントを使用し, API.chunked_upload_init(), API.chunked_upload_append(), 及び API.chunked_upload_finalize() を呼ぶ. もし wait_for_async_finalize が設定されていれば API.get_media_upload_status() も呼びだす.

Parameters
  • filename – アップロードするメディアのファイル名. file オブジェクトが指定されていない場合, 自動的にファイルオープンされる.

  • filefilename を開くときに使用されるファイルオブジェクト. MIME タイプ検出と POST データのために filename は必要.

  • file_type – アップロードしようとしているメディアの MIME タイプ.

  • wait_for_async_finalize – Twitter API がメディアの処理を終えるのを待つかどうか. デフォルトでは True.

  • media_category – メディアがどのように利用されるかを示すカテゴリ. この項目は Ads API でメディアを利用する際に必要となる.

  • additional_owners – 画像などの media_id をツイートや Twitter カードで共有するユーザ ID のリスト. 最大 100 アカウントまで共有できる.

Returns

Return type

Media

References

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/uploading-media/chunked-media-upload

API.chunked_upload_append(media_id, media, segment_index)

このメソッドではメディアファイルのチャンク (連続したバイト範囲) を アップロードする.

Parameters
  • media_id – アップロード開始メソッド chunked_upload_init が返す media_id.

  • media – アップロードする生のバイナリファイル. 5 MB 以下である必要がある.

  • segment_index – ファイルチャンクの順序付きインデックス. 0 - 999 の範囲である必要がある. 最初のセグメントは 0, 次のセグメントは 1, …と続く.

References

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-append

API.chunked_upload_finalize(media_id)

メディアファイル全体が chunked_upload_append メソッドで アップロードされたあとに使うメソッド. レスポンスに processing_info field のみが含まれている場合, ツイートを作成処理をする前にステータスをチェックし, 成功するまで待つことが必要かもしれない.

Parameters

media_id – アップロード開始メソッド chunked_upload_init が返す media_id.

Returns

Return type

Media

References

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-finalize

API.chunked_upload_init(total_bytes, media_type, *, media_category, additional_owners)

チャンクファイル (連続したファイル) のアップロードセッションを 開始するときに使うメソッド.

Parameters
  • total_bytes – アップロードされるメディアのサイズ (バイト表示).

  • media_type – アップロードされるメディアの MIME タイプ.

  • media_category – メディアがどのように利用されるかを示すカテゴリ. この項目は Ads API でメディアを利用する際に必要となる.

  • additional_owners – 画像などの media_id をツイートや Twitter カードで共有するユーザ ID のリスト. 最大 100 アカウントまで共有できる.

Returns

Return type

Media

References

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-init

トレンド

近場のトレンドを取得する

特定の WOEID (Where On Earth IDentifier; 地球上の場所に付けた識別子) において 利用できるトレンド情報があれば TOP 50 までを返します.

返り値の「トレンド」オブジェクト配列は, エンコードされたトレンドトピックの名称, Twitter 検索でトピックを検索するためのクエリ及び Twitter 検索の URL を含みます.

この情報は 5 分間キャッシュされ, それ以上の頻度でリクエストしても 新しい情報は返されません. さらに利用制限の使用量にカウントされます.

また可能であれば, 多くのトレンドにおける過去 24 時間の tweet_volume も返されます.

Parameters
  • id – トレンド情報を返したい場所の Yahoo! WOEID. WOEID として 1 を指定するとグローバルトレンドが得られる. (訳注: WOEID は海外の YAHOO! によって割り当てられている)

  • exclude – ここにハッシュタグのキーワードを設定するとトレンドリストから除外する.

Returns

JSON

Return type

dict

References

https://developer.twitter.com/en/docs/twitter-api/v1/trends/trends-for-location/api-reference/get-trends-place

場所情報 ===

Get information about a place

API.geo_id(place_id)

Given place_id, provide more details about that place.

Parameters

place_id – Valid Twitter ID of a location.

Returns

Return type

Place

References

https://developer.twitter.com/en/docs/twitter-api/v1/geo/place-information/api-reference/get-geo-id-place_id

Get places near a location

API.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.

This request is an informative call and will deliver generalized results about geography.

Parameters
  • lat – The location’s latitude.

  • long – The location’s longitude.

  • accuracy – Specify the “region” in which to search, such as a number (then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet). If this is not passed in, then it is assumed to be 0m

  • granularity – Assumed to be neighborhood by default; can also be city.

  • max_results – A hint as to the maximum number of results to return. This is only a guideline, which may not be adhered to.

Returns

Return type

List[Place]

References

https://developer.twitter.com/en/docs/twitter-api/v1/geo/places-near-location/api-reference/get-geo-reverse_geocode

API.search_geo(*, lat, long, query, ip, granularity, max_results)

Search for places that can be attached to a Tweet via API.update_status(). Given a latitude and a longitude pair, an IP address, or a name, this request will return a list of all the valid places that can be used as the place_id when updating a status.

Conceptually, a query can be made from the user’s location, retrieve a list of places, have the user validate the location they are at, and then send the ID of this location with a call to API.update_status().

This is the recommended method to use find places that can be attached to API.update_status(). Unlike API.reverse_geocode() which provides raw data access, this endpoint can potentially re-order places with regards to the user who is authenticated. This approach is also preferred for interactive place matching with the user.

Some parameters in this method are only required based on the existence of other parameters. For instance, lat is required if long is provided, and vice-versa.

Parameters
  • lat – The latitude to search around. This parameter will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn’t a corresponding long parameter.

  • long – The longitude to search around. The valid ranges for longitude are -180.0 to +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if geo_enabled is turned off, or if there not a corresponding lat parameter.

  • query – Free-form text to match against while executing a geo-based query, best suited for finding nearby locations by name.

  • ip – An IP address. Used when attempting to fix geolocation based off of the user’s IP address.

  • granularity

    This is the minimal granularity of place types to return and must be one of: neighborhood, city, admin or country. If no granularity is provided for the request neighborhood is assumed.

    Setting this to city, for example, will find places which have a type of city, admin or country.

  • max_results – A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many “nearby” results to return. Ideally, only pass in the number of places you intend to display to the user here.

Returns

Return type

List[Place]

References

https://developer.twitter.com/en/docs/twitter-api/v1/geo/places-near-location/api-reference/get-geo-search

Developer utilities

Get Twitter supported languages

API.supported_languages()

Returns the list of languages supported by Twitter along with the language code supported by Twitter.

The language code may be formatted as ISO 639-1 alpha-2 (en), ISO 639-3 alpha-3 (msa), or ISO 639-1 alpha-2 combined with an ISO 3166-1 alpha-2 localization (zh-tw).

Returns

JSON

Return type

dict

References

https://developer.twitter.com/en/docs/twitter-api/v1/developer-utilities/supported-languages/api-reference/get-help-languages

Get app rate limit status

API.rate_limit_status(*, resources)

Returns the current rate limits for methods belonging to the specified resource families. When using application-only auth, this method’s response indicates the application-only auth rate limiting context.

Parameters

resources – A comma-separated list of resource families you want to know the current rate limit disposition for.

Returns

JSON

Return type

dict

References

https://developer.twitter.com/en/docs/twitter-api/v1/developer-utilities/rate-limit-status/api-reference/get-application-rate_limit_status

Footnotes

1

https://web.archive.org/web/20170829051949/https://dev.twitter.com/rest/reference/get/search/tweets

2

https://twittercommunity.com/t/favorited-reports-as-false-even-if-status-is-already-favorited-by-the-user/11145