API

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)

트위터 API v1.1 레퍼런스

버전 4.11에서 변경: Added support for include_ext_edit_control endpoint/method parameter

버전 4.14에서 변경: Removed search_30_day and search_full_archive methods, as the Premium v1.1 API has been deprecated

매개변수
  • auth – 사용할 인증 처리기

  • cache – GET 메서드가 사용되는 경우 쿼리할 캐시

  • host – 일반 REST API 호스트 서버의 URL

  • parser – 트위터에서의 응답을 파싱(구문 분석)하는 데 사용할 파서 인스턴스; 기본적으로 ModelParser 인스턴스가 사용됩니다.

  • proxy – 트위터 연결에 사용할 HTTPS 프록시의 전체 URL

  • retry_count – 오류 발생 시 재시도할 횟수

  • retry_delay – 재시도 간격 (초 단위)

  • retry_errors – 재시도할 HTTP 상태 코드

  • timeout – 트위터로부터의 응답을 기다릴 최대 시간

  • upload_host – 업로드 서버의 URL

  • wait_on_rate_limit – 트위터 API 호출 제한 횟수 보충을 기다릴지의 여부

예외 발생

TypeError – 주어진 파서가 파서 인스턴스가 아닌 경우

참조

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

트위터 API v1.1 엔드포인트

API 메서드

트윗

Get Tweet timelines

가져오기: statuses/home_timeline

API.home_timeline()

가져오기: statuses/mentions_timeline

API.mentions_timeline()

가져오기: statuses/user_timeline

API.user_timeline()

Post, retrieve, and engage with Tweets

가져오기: favorites/list

API.get_favorites()

가져오기: statuses/lookup

API.lookup_statuses()

가져오기: statuses/oembed

API.get_oembed()

가져오기: statuses/retweeters/ids

API.get_retweeter_ids()

가져오기: statuses/retweets/:id

API.get_retweets()

가져오기: statuses/retweets_of_me

API.get_retweets_of_me()

가져오기: statuses/show/:id

API.get_status()

게시: favorites/create

API.create_favorite()

게시: favorites/destroy

API.destroy_favorite()

게시: statuses/destroy/:id

API.destroy_status()

게시: statuses/retweet/:id

API.retweet()

게시: statuses/unretweet/:id

API.unretweet()

게시: statuses/update

API.update_status()

게시: statuses/update_with_media

API.update_status_with_media()

Search Tweets

가져오기: search/tweets

API.search_tweets()

계정 및 사용자

Create and manage lists

가져오기: lists/list

API.get_lists()

가져오기: lists/members

API.get_list_members()

가져오기: lists/members/show

API.get_list_member()

가져오기: lists/memberships

API.get_list_memberships()

가져오기: lists/ownerships

API.get_list_ownerships()

가져오기: lists/show

API.get_list()

가져오기: lists/statuses

API.list_timeline()

가져오기: lists/subscribers

API.get_list_subscribers()

가져오기: lists/subscribers/show

API.get_list_subscriber()

가져오기: lists/subscriptions

API.get_list_subscriptions()

게시: lists/create

API.create_list()

게시: lists/destroy

API.destroy_list()

게시: lists/members/create

API.add_list_member()

게시: lists/members/create_all

API.add_list_members()

게시: lists/members/destroy

API.remove_list_member()

게시: lists/members/destroy_all

API.remove_list_members()

게시: lists/subscribers/create

API.subscribe_list()

게시: lists/subscribers/destroy

API.unsubscribe_list()

게시: lists/update

API.update_list()

Follow, search, and get users

가져오기: followers/ids

API.get_follower_ids()

가져오기: followers/list

API.get_followers()

가져오기: friends/ids

API.get_friend_ids()

가져오기: friends/list

API.get_friends()

가져오기: friendships/incoming

API.incoming_friendships()

가져오기: friendships/lookup

API.lookup_friendships()

가져오기: friendships/no_retweets/ids

API.no_retweets_friendships()

가져오기: friendships/outgoing

API.outgoing_friendships()

가져오기: friendships/show

API.get_friendship()

가져오기: users/lookup

API.lookup_users()

가져오기: users/search

API.search_users()

가져오기: users/show

API.get_user()

게시: friendships/create

API.create_friendship()

게시: friendships/destroy

API.destroy_friendship()

게시: friendships/update

API.update_friendship()

Manage account settings and profile

가져오기: account/settings

API.get_settings()

가져오기: account/verify_credentials

API.verify_credentials()

가져오기: saved_searches/list

API.get_saved_searches()

가져오기: saved_searches/show/:id

API.get_saved_search()

가져오기: users/profile_banner

API.get_profile_banner()

게시: account/remove_profile_banner

API.remove_profile_banner()

게시: account/settings

API.set_settings()

게시: account/update_profile

API.update_profile()

게시: account/update_profile_banner

API.update_profile_banner()

게시: account/update_profile_image

API.update_profile_image()

게시: saved_searches/create

API.create_saved_search()

게시: saved_searches/destroy/:id

API.destroy_saved_search()

Mute, block, and report users

가져오기: blocks/ids

API.get_blocked_ids()

가져오기: blocks/list

API.get_blocks()

가져오기: mutes/users/ids

API.get_muted_ids()

가져오기: mutes/users/list

API.get_mutes()

게시: blocks/create

API.create_block()

게시: blocks/destroy

API.destroy_block()

게시: mutes/users/create

API.create_mute()

게시: mutes/users/destroy

API.destroy_mute()

게시: users/report_spam

API.report_spam()

Direct Messages

Sending and receiving events

DELETE direct_messages/events/destroy

API.delete_direct_message()

가져오기: direct_messages/events/list

API.get_direct_messages()

가져오기: direct_messages/events/show

API.get_direct_message()

게시: direct_messages/events/new

API.send_direct_message()

Typing indicator and read receipts

POST direct_messages/indicate_typing

API.indicate_direct_message_typing()

POST direct_messages/mark_read

API.mark_direct_message_read()

미디어

Upload media

가져오기: media/upload

API.get_media_upload_status()

게시: media/metadata/create

API.create_media_metadata()

API.media_upload()

게시: media/upload

API.simple_upload()

API.chunked_upload()

게시: media/upload (APPEND)

API.chunked_upload_append()

게시: media/upload (FINALIZE)

API.chunked_upload_finalize()

게시: media/upload (INIT)

API.chunked_upload_init()

트렌드

Get locations with trending topics

가져오기: trends/available

API.available_trends()

가져오기: trends/closest

API.closest_trends()

Get trends near a location

가져오기: trends/place

API.get_place_trends()

위치 및 지리 정보

Get information about a place

가져오기: geo/id/:place_id

API.geo_id()

Get places near a location

가져오기: geo/reverse_geocode

API.reverse_geocode()

가져오기: geo/search

API.search_geo()

개발자 도구

Get Twitter supported languages

가져오기: help/languages

API.supported_languages()

Get app rate limit status

가져오기: application/rate_limit_status

API.rate_limit_status()

트윗

트윗 타임라인 가져오기

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

현재 인증된 사용자 또는 지정된 사용자의 트윗 및 리트윗을 포함하는 트윗(status) 중 가장 최근의 20개를 반환합니다. 웹 상에서의 /timeline/home와 일치합니다.

매개변수
  • count – 각 페이지당 보여질 결과 수.

  • since_id – 지정한 ID보다 더 큰 ID값을 가지는 객체(즉, 지정한 객체보다 더 최근의 객체)만을 반환함.

  • max_id – 지정한 ID보다 더 작은 ID값을 가지는 객체(즉, 지정한 객체보다 더 이전의 객체)만을 반환함.

  • trim_user – 유저 ID가 반드시 유저 객체 대신 제공되어야 하는지를 나타내는 boolean 형태의 변수. 기본값은 False.

  • exclude_replies – 가져온 타임라인에서 답글(멘션)이 반환되지 않도록 합니다. count 값과 함께 exclude_replies 를 사용하면 보다 최신 트윗까지 받을 수 있는데, 이는 count 를 단독으로 사용하면 리트윗과 답글도 결과값에 포함되기 때문입니다.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

반환값

반환 형식

List[Status]

참조

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개를 반환합니다.

매개변수
  • count – 각 페이지당 보여질 결과 수.

  • since_id – 지정한 ID보다 더 큰 ID값을 가지는 객체(즉, 지정한 객체보다 더 최근의 객체)만을 반환함.

  • max_id – 지정한 ID보다 더 작은 ID값을 가지는 객체(즉, 지정한 객체보다 더 이전의 객체)만을 반환함.

  • trim_user – 유저 ID가 반드시 유저 객체 대신 제공되어야 하는지를 나타내는 boolean 형태의 변수. 기본값은 False.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

반환값

반환 형식

List[Status]

참조

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)

현재 인증된 사용자 또는 지정한 사용자의 최근 트윗(status) 20개를 반환합니다.id값을 통해, 다른 사용자의 타임라인을 불러오는 것도 가능합니다.

매개변수
  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • since_id – 지정한 ID보다 더 큰 ID값을 가지는 객체(즉, 지정한 객체보다 더 최근의 객체)만을 반환함.

  • count – 각 페이지당 보여질 결과 수.

  • max_id – 지정한 ID보다 더 작은 ID값을 가지는 객체(즉, 지정한 객체보다 더 이전의 객체)만을 반환함.

  • trim_user – 유저 ID가 반드시 유저 객체 대신 제공되어야 하는지를 나타내는 boolean 형태의 변수. 기본값은 False.

  • exclude_replies – 가져온 타임라인에서 답글(멘션)이 반환되지 않도록 합니다. count 값과 함께 exclude_replies 를 사용하면 보다 최신 트윗까지 받을 수 있는데, 이는 count 를 단독으로 사용하면 리트윗과 답글도 결과값에 포함되기 때문입니다.

  • include_rtsfalse 로 설정된 경우, 타임라인에서 리트윗들을 모두 제거합니다.(단, 타임라인의 최대 길이 제한이나 count에 의해 선택된 슬라이스(Slice)에는 계산됩니다)참고: trim_user 매개변수를 include_rts와 함께 사용하는 경우에도리트윗에는 사용자 개체가 전체 포함됩니다.

반환값

반환 형식

List[Status]

참조

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)

현재 인증된 사용자 또는 지정한 사용자의 최근 〈마음에 들어요〉 20개를 반환합니다.id값을 통해, 다른 사용자의 〈마음의 들어요’를 불러오는 것도 가능합니다.

버전 4.0에서 변경: Renamed from API.favorites

매개변수
  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • count – 각 페이지당 보여질 결과 수.

  • since_id – 지정한 ID보다 더 큰 ID값을 가지는 객체(즉, 지정한 객체보다 더 최근의 객체)만을 반환함.

  • max_id – 지정한 ID보다 더 작은 ID값을 가지는 객체(즉, 지정한 객체보다 더 이전의 객체)만을 반환함.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

반환값

반환 형식

List[Status]

참조

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)

id 값으로 지정한 최대 100개의 트윗에 대한 전체 트윗 개체를 반환합니다.

버전 4.0에서 변경: Renamed from API.statuses_lookup

매개변수
  • id – 검색할 트윗 ID의 리스트 (최대 100개까지 가능)

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • trim_user – 유저 ID가 반드시 유저 객체 대신 제공되어야 하는지를 나타내는 boolean 형태의 변수. 기본값은 False.

  • map – 전체 유저 객체 대신 user_id를 제공할지를 지정하는 boolean 값입니다. 기본값은 False.

  • include_ext_alt_text – 첨부된 미디어 엔티티에 대체 텍스트(Alt text)가 존재하는 경우, 이 매개변수를 이용하면 미디어 엔티티 최상위 키에 ext_alt_text값을 반환할지를 지정하는 boolean 값입니다. 값이 따로 설정되지 않은 경우 트위터 API에서의 기본 반환값은 null 입니다.

  • include_card_uri – 트윗에 광고 카드나 card_uri를 이용한 카드가 부착되어 있는 경우, 검색된 트윗에 cart_uri가 포함되어야 하는지를 지정하는 boolean 값입니다.

반환값

반환 형식

List[Status]

참조

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)

웹 주소(URL)나 ID로 지정한 단일 트윗을 oEmbed 호환 형식으로 반환합니다. 반환된 HTML 스니펫은, 트위터 위젯 자바스크립트가 페이지에 포함되어 있을 시 임베디드 트윗으로 자동 인식됩니다.

oEmbed 엔드포인트는, HTML 마크업의 관련 속성을, HTML 응답과 함께 번들로 제공되는 트위터의 자바스크립트에 의해 해석되도록 설정하여, 임베디드 트윗의 최종 모습을 사용자 지정할 수 있도록 해 줍니다. 트위터가 새로운 기능을 추가하거나, 트윗의 표현 방식을 조정함에 따라 반환되는 마크업 형식도 변경될 수 있습니다.

트윗의 Fallback 마크업은 cache_age 에 지정된 권장 수명동안만 서버에 캐시되도록 되어 있습니다.

매개변수
  • url – 임베드할 트윗의 URL

  • maxwidth – 렌더링될 트윗의 최대 너비(픽셀)이며, 허용 범위는 220px에서 550px입니다. 허용 범위보다 작거나 큰 값을 입력하면 각각 허용 범위의 최소 및 최대 너비로 설정되며, width 속성을 이용해 너비를 설정해도 이 반환값에 반영됩니다. 단, 트위터가 oEmbed의 maxheight 매개변수를 지원하지 않는다는 점은 유의하시기 바랍니다. 트윗은 기본적으로 텍스트이기에, 이미지나 영상처럼 높이를 예측할 수 없습니다. 이와 관련하여, oEmbed 응답은 height 값을 제공하지 않습니다.각 트윗별로 일관된 높이를 지정해야 할 경우, 아래의 hide_threadhide_media 매개변수를 참조하시기 바랍니다.

  • hide_mediatrue, "t" 또는 1 로 설정된 경우, 트윗이 이미지, 사진, 링크 등의 미리보기를 제공하지 않습니다.

  • hide_threadtrue, "t" 또는 1 로 설정된 경우, 트윗의 스레드(타래) 기준 이전 트윗들이 보이지 않습니다.

  • omit_scripttrue, "t" 또는 1 로 설정된 경우, widget.js 로드를 담당하는 <script> 가 반환되지 않습니다. 이를 사용하는 웹페이지에는 모든 트위터 위젯에서 사용할 widget.js 에 대한 자체 참조를 포함해야만 합니다.

  • align – 임베드된 트윗을 부모 요소 기준, 페이지의 왼쪽, 오른쪽 또는 가운데 중 어디에 띄울지를 지정합니다. left, right, center, none 중 하나의 값만 사용할 수 있습니다.

  • related – 쉼표(,)로 구분되어 있는, 특정 컨텐츠와 관련 있는 트위터 사용자명(username)의 목록입니다.이 값은 뷰어가 포함된 트윗에 답글을 달거나, 리트윗 또는 〈마음에 들어요’를 하도록 선택한 경우 트윗 액션으로 전달합니다.

  • lang – 반환할 HTML과 렌더링된 트윗을, 임베디드 트윗에 의해 지원되는 특정 트위터 언어로 반환해줄 것을 요청합니다.

  • themedark 로 설정하면, 트윗이 어두운 배경에 밝은색 텍스트의 꼴로 표시됩니다.

  • link_color – 트윗의 링크 색상을 조정합니다. 색상 값은 16진수로 입력합니다.

  • widget_type – 트위터 비디오 임베드를 반환받으려면 video 로 설정합니다.

  • dnttrue 로 설정하면, 임베드된 사이트와 트윗이 맞춤 컨텐츠 및 광고에 사용되지 않습니다.

반환값

JSON

반환 형식

dict

참조

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로 지정한 트윗을 리트윗한 사용자를 최대 100명까지 반환합니다.

버전 4.0에서 변경: Renamed from API.retweeters

매개변수
  • id – 특정 트윗(status)의 ID.

  • count – 각 페이지당 보여질 결과 수.

  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

  • stringify_ids – ID를 문자열로 반환하도록 설정.

반환값

반환 형식

List[int]

참조

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)

지정한 트윗을 리트윗한 사용자를 최근 순으로 100명까지 반환합니다.

버전 4.0에서 변경: Renamed from API.retweets

매개변수
  • id – 특정 트윗(status)의 ID.

  • count – 각 페이지당 보여질 결과 수.

  • trim_user – 유저 ID가 반드시 유저 객체 대신 제공되어야 하는지를 나타내는 boolean 형태의 변수. 기본값은 False.

반환값

반환 형식

List[Status]

참조

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개를 반환합니다.

버전 4.0에서 변경: Renamed from API.retweets_of_me

매개변수
  • count – 각 페이지당 보여질 결과 수.

  • since_id – 지정한 ID보다 더 큰 ID값을 가지는 객체(즉, 지정한 객체보다 더 최근의 객체)만을 반환함.

  • max_id – 지정한 ID보다 더 작은 ID값을 가지는 객체(즉, 지정한 객체보다 더 이전의 객체)만을 반환함.

  • trim_user – 유저 ID가 반드시 유저 객체 대신 제공되어야 하는지를 나타내는 boolean 형태의 변수. 기본값은 False.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • include_user_entities – False로 설정하면 사용자 객체 노드를 포함하지 않음. 기본값은 True.

반환값

반환 형식

List[Status]

참조

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로 지정한 특정 트윗(status)을 반환합니다.

매개변수
  • id – 특정 트윗(status)의 ID.

  • trim_user – 유저 ID가 반드시 유저 객체 대신 제공되어야 하는지를 나타내는 boolean 형태의 변수. 기본값은 False.

  • include_my_retweet – 지정한 트윗이 현재 인증된 사용자가 리트윗한 트윗일 경우, 원본 트윗의 ID를 포함하고 있는 current_user_retweet 노드를 포함해야 하는지의 여부를 나타내는 boolean 값입니다.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • include_ext_alt_text – 첨부된 미디어 엔티티에 대체 텍스트(Alt text)가 존재하는 경우, 이 매개변수를 이용하면 미디어 엔티티 최상위 키에 ext_alt_text값을 반환할지를 지정하는 boolean 값입니다. 값이 따로 설정되지 않은 경우 트위터 API에서의 기본 반환값은 null 입니다.

  • include_card_uri – 트윗에 광고 카드나 card_uri를 이용한 카드가 부착되어 있는 경우, 검색된 트윗에 cart_uri가 포함되어야 하는지를 지정하는 boolean 값입니다.

반환값

반환 형식

Status

참조

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)

지정한 트윗(status)에, 현재 인증된 사용자로서 〈마음에 들어요’를 표시합니다.

매개변수
  • id – 특정 트윗(status)의 ID.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

반환값

반환 형식

Status

참조

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

API.destroy_favorite(id, *, include_entities)

지정한 트윗(status)에, 현재 인증된 사용자로서의 〈마음에 들어요’를 취소합니다.

매개변수
  • id – 특정 트윗(status)의 ID.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

반환값

반환 형식

Status

참조

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로 지정한 트윗(status)을 삭제합니다. 현재 인증된 사용자가 삭제할 트윗(status)의 작성자여야 합니다.

매개변수
  • id – 특정 트윗(status)의 ID.

  • trim_user – 유저 ID가 반드시 유저 객체 대신 제공되어야 하는지를 나타내는 boolean 형태의 변수. 기본값은 False.

반환값

반환 형식

Status

참조

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가 필요합니다.

매개변수
  • id – 특정 트윗(status)의 ID.

  • trim_user – 유저 ID가 반드시 유저 객체 대신 제공되어야 하는지를 나타내는 boolean 형태의 변수. 기본값은 False.

반환값

반환 형식

Status

참조

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가 필요합니다.

매개변수
  • id – 특정 트윗(status)의 ID.

  • trim_user – 유저 ID가 반드시 유저 객체 대신 제공되어야 하는지를 나타내는 boolean 형태의 변수. 기본값은 False.

반환값

반환 형식

Status

참조

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)

현재 인증된 사용자의 status를 갱신합니다(=트윗을 작성합니다).

각 트윗 작성 시도마다, 본문을 현재 인증된 사용자의 최근 트윗과 비교합니다. 중복된 본문 작성은 불가능하며, 이는 HTTP 403 오류를 반환합니다. 다시 말해, 같은 트윗을 연속으로 작성할 수 없습니다.

더불어 API 제한에 걸리지 않았더라도, 사용자는 한 번에 게시할 수 있는 트윗 수에 제한이 있습니다. 사용자가 게시한 트윗이 특정 제한에 도달해도 이 메서드는 HTTP 403 오류를 반환합니다.

매개변수
  • status – 작성할 트윗(status)의 본문.

  • in_reply_to_status_id – (답글을 작성하는 경우) 답글을 달 원본 트윗의 ID. 참고: 이 매개변수가 참조하는 트윗 작성자를 트윗(status) 본문에 언급하지 않는 한, 이 매개변수는 무시됩니다. 따라서, 본문에 @username를 포함해야 하며, 여기서 username은 답글을 달 원본 트윗의 작성자의 것으로 입력합니다.

  • auto_populate_reply_metadata – true로 설정하고 in_reply_to_status_id와 함께 사용하면, 원본 트윗에서의 기존 @mention들을 검색하고 이를 새 트윗에 추가합니다. 이렇게 하면 답글 타래(reply chain)가 길어질 때, @mention의 제한에 도달할 때까지 확장 트윗의 메타데이터에 @mention을 추가합니다.이때, 원본 트윗이 삭제된 경우 답글 작성은 실패합니다.

  • exclude_reply_user_ids – auto_populate_reply_metadata와 함께 사용할 경우, 확장 트윗 앞부분의 서버 생성 @mention 목록에서, 쉼표(,)로 구분되고 ID로 지정된, 사용자(들)을 제거합니다.단, 원본 트윗 작성자에 대한 @mention을 제거하는 것은, in_reply_to_status_id의 의미와 충돌하기 떄문에 불가능합니다. 이 @mention을 제거하려는 시도는 자동적으로 무시됩니다.

  • attachment_url – 트윗(status)의 본문 제한에 URL이 계산되지 않도록, 트윗에 첨부하는 형식으로 URL을 포함합니다. 단, 이 URL은 트윗의 permalink 또는 쪽지(DM)의 딥 링크(deep link)여야 합니다. 이에 해당되지 않는 URL은 트윗 본문에 있어야 합니다. 만약 이를 attachment_url에 할당하려 시도하면 트윗 생성에 실패하며, 예외가 발생합니다.

  • media_ids – 트윗에 연결할 media_id의 목록입니다. 한 개의 트윗은 최대 4장의 이미지, 1장의 움직이느 GIF 및 1개의 영상을 포함할 수 있습니다.

  • possibly_sensitive – 노출 및 의료 시술과 같은 민감한 컨텐츠로 간주될 수 있는 미디어를 트윗에 업로드할 경우, 이 값을 반드시 true로 설정해야 합니다.

  • lat – 이 트윗이 가리킬 위치의 위도. -90.0 ~ +90.0 (북반구가 양수값) 범위 밖의 값은 무시되며, 아래의 long 매개변수가 지정되지 않은 경우에도 무시됩니다.

  • long – 이 트윗이 가리킬 위치의 경도. -180.0 ~ +180.0 (동쪽이 양수값) 범위 밖의 값, 숫자 이외의 값이 입력될 경우 무시되며, geo_enabled 가 비활성화 되었거나, 위의 lat 매개변수가 지정되지 않은 경우나, geo_enabled가 비활성화된 에도 전달된 값이 무시됩니다.

  • place_id – (사용자가 위치 정보를 사용할 수 있는 경우) 트윗이 작성된 위치의 ID.

  • display_coordinates – 트윗이 작성되어 전송된 위치를 표시할지의 여부.

  • trim_user – 유저 ID가 반드시 유저 객체 대신 제공되어야 하는지를 나타내는 boolean 형태의 변수. 기본값은 False.

  • card_uri – 트윗에 card_uri 속성을 이용하여 광고 카드를 추가합니다.

반환값

반환 형식

Status

참조

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)

현재 인증된 사용자의 Status를 미디어와 함께 업데이트합니다. 중복된 Status 작성 시도 또는 너무 긴 트윗의 작성 시도는 별다른 경고 없이 무시될 것입니다.

버전 4.0에서 변경: Renamed from API.update_with_media

매개변수
  • status – 작성할 트윗(status)의 본문.

  • filename – 업로드할 이미지의 이름. file 을 따로 지정하지 않으면 이 파일이 자동으로 열립니다.

  • file – 파일 객체로, filename 를 직접 여는 것 대신 사용됩니다. 물론 MIME 타입 감지 및 POST 데이터 형식의 필드로 filename 가 필요하기는 합니다.

  • possibly_sensitive – 민감한 컨텐츠일 경우 true로 설정합니다.

  • in_reply_to_status_id – 답글을 작성할 대상 트윗(status)의 ID.

  • lat – 이 트윗이 가리킬 위치의 위도.

  • long – 이 트윗이 가리킬 위치의 경도.

  • place_id – (사용자가 위치 정보를 사용할 수 있는 경우) 트윗이 작성된 위치의 정보 (ID).

  • display_coordinates – 트윗이 작성되어 전송된 위치를 표시할지의 여부.

반환값

반환 형식

Status

참조

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)

특정 쿼리에 일치하는 트윗 컬렉션을 반환합니다.

트위터의 검색 서비스 및 검색 API가 모든 트윗을 대상으로 검색 작업을 수행하는 것은 아니라는 것을 유의하세요. 모든 트윗이 검색 인터페이스를 통해 색인화 되어있거나 검색할 수 있게 만들어져 있지는 않습니다.

참고

Twitter’s standard search API only 《searches against a sampling of recent Tweets published in the past 7 days.》

If you’re specifying an ID range beyond the past 7 days or there are no results from the past 7 days, then no results will be returned.

See Twitter’s documentation on the standard search API for more information.

참고

API v1.1에서는, 검색 API의 응답 형식이 REST API나 플랫폼을 통해서 볼 수 있는 객체와 더 비슷한 트윗 객체를 반환하도록 향상되었습니다. 하지만, perspectival 속성(인증된 사용자에 의존하는 필드)은 현재 지원하지 않습니다. 12

버전 4.0에서 변경: Renamed from API.search

매개변수
  • q – 연산자를 포함하여 최대 500자의 검색하고자 하는 문자열 쿼리. 쿼리는 추가적으로 복잡도에 따라 제한될 수 있습니다.

  • geocode – 주어진 위도, 경도의 주어진 반경 내에 위치한 사용자의 트윗만 반환합니다. 위치는 우선적으로 위치 정보 삽입 API에서 받아오지만, 트위터 프로필 내의 정보로 대체할 수 있습니다. 매개변수의 값은 《위도, 경도, 반경》의 형태로 지정되며, 반경은 《mi》(마일) 또는 《km》(킬로미터) 단위로 주어져야 합니다. API를 통해 근거리 연산자를 사용하여 임의의 위치를 geocode로 입력할 수는 없다는 점을 유의해주세요. 다만 이 geocode 매개변수를 통해 근처의 지오코드를 검색할 수는 있습니다. 반경 수식어를 사용할 경우에는 최대 1,000개의 분명하게 구분되는 《하위 영역》을 고려할 할 것입니다.

  • lang – 트윗을 ISO 639-1 코드로 주어진 언어로 제한합니다. 언어 감지가 적절하게 작동했다고 전제합니다.

  • locale – 전송한 쿼리의 언어를 명시합니다. (현재는 ja만 유효합니다.) 이는 언어별 사용자를 위한 것이며 대부분의 경우엔 기본값이 적용됩니다.

  • result_type

    얻고 싶은 검색 결과의 형식에 대해 명시합니다. 기본값은 《mixed》.유효한 값은 다음과 같습니다:

    • 》mixed》: 응답에 인기 결과와 실시간 결과 모두를 포함합니다.

    • 》recent》: 응답으로 가장 최근의 결과만을 반환합니다.

    • 》popular》: 응답으로 가장 인기 있는 결과만을 반환합니다.

  • count – 각 페이지당 보여질 결과 수.

  • until – 주어진 날짜 이전에 작성된 트윗을 반환합니다. 날짜는 YYYY-MM-DD의 형식으로 주어져야 합니다. 검색 색인은 7일 간만 유지됩니다. 다시 말해, 작성된 지 일주일 이상 지난 트윗은 찾을 수 없습니다.

  • since_id – Returns only statuses with an ID greater than (that is, more recent than) the specified ID. API를 통해서 접근할 수 있는 트윗의 수에는 제한이 있습니다. since_id 값으로 인해 트윗 수 제한을 초과하게 된다면, since_id 는 제한을 초과하지 않는 가장 오래된 ID로 강제 재설정됩니다.

  • max_id – 지정한 ID보다 더 작은 ID값을 가지는 객체(즉, 지정한 객체보다 더 이전의 객체)만을 반환함.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

반환값

반환 형식

SearchResults

참조

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_idscreen_name 매개변수를 사용하여 사용자를 지정해야 하며, 지정하지 않을 경우, 현재 인증된 사용자를 기준으로 합니다.

이 메서드는 최대 100개의 결과를 반환하며, 구독 중인 리스트가 먼저 반환되고, 이후에 소유 중인 리스트가 반환됩니다. 따라서 만약 사용자가 90개의 리스트를 팔로우하고 있고, 20개의 리스트를 소유하고 있다면 메서드는 90개의 팔로우 중인 리스트와, 10개의 소유 중인 리스트를 반환할 것입니다.단, reverse 값이 True로 설정된 경우에는(reverse=true) 소유 중인 리스트를 먼저 반환하므로, 20개의 소유 중인 리스트와 80개의 구독 중인 리스트가 반환될 것입니다.

버전 4.0에서 변경: Renamed from API.lists_all

매개변수
  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • reverse – 소유 중인 리스트를 먼저 반환받을지의 여부. 기본값은 False.이 매개변수에 관한 설명은 위를 참고하면 됩니다.

반환값

반환 형식

List[List]

참조

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)

지정한 사용자가 추가되어 있는 리스트를 반환합니다.

버전 4.0에서 변경: Renamed from API.list_members

매개변수
  • list_id – 리스트의 ID. (숫자형)

  • slug – 숫자형 ID값 대신, 슬러그(slug)값으로 리스트를 식별할 수 있습니다. 이렇게 하려면, owner_id 또는 owner_screen_name 매개변수를 사용해 목록 소유자를 지정해야만 합니다.

  • owner_screen_name – 슬러그(slug)값으로 지정한 리스트 소유자의 screen_name입니다.

  • owner_id – 슬러그(slug)값으로 지정한 리스트 소유자의 ID값입니다.

  • count – 각 페이지당 보여질 결과 수.

  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • skip_status – 트윗(status)을 반환될 사용자 객체에 포함하지 않을지의 여부를 나타내는 boolean값입니다. 기본값은 False(사용자 객체에 포함함).

반환값

반환 형식

List[User]

참조

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)

지정한 사용자가 지정한 리스트의 구성원인지를 확인합니다.

버전 4.0에서 변경: Renamed from API.show_list_member

매개변수
  • list_id – 리스트의 ID. (숫자형)

  • slug – 숫자형 ID값 대신, 슬러그(slug)값으로 리스트를 식별할 수 있습니다. 이렇게 하려면, owner_id 또는 owner_screen_name 매개변수를 사용해 목록 소유자를 지정해야만 합니다.

  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • owner_screen_name – 슬러그(slug)값으로 지정한 리스트 소유자의 screen_name입니다.

  • owner_id – 슬러그(slug)값으로 지정한 리스트 소유자의 ID값입니다.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • skip_status – 트윗(status)을 반환될 사용자 객체에 포함하지 않을지의 여부를 나타내는 boolean값입니다. 기본값은 False(사용자 객체에 포함함).

예외 발생

NotFound – 사용자가 리스트의 구성원이 아닌 경우.

반환값

반환 형식

User

참조

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_id나 screen_name값이 지정되지 않은 경우, 현재 인증된 사용자를 기준으로 한 결과를 반환합니다.

버전 4.0에서 변경: Renamed from API.lists_memberships

매개변수
  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • count – 각 페이지당 보여질 결과 수.

  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

  • filter_to_owned_lists – 현재 인증된 사용자가 소유 중인 리스트도 같이 반환할지의 여부. user_id 또는 screen_name 으로 특정 사용자를 지정했을 경우, 대상은 해당 사용자가 됩니다.

반환값

반환 형식

List[List]

참조

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 으로 특정 사용자를 지정하지 않을 경우, 대상은 현재 인증된 사용자가 됩니다.

매개변수
  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • count – 각 페이지당 보여질 결과 수.

  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

반환값

반환 형식

List[List]

참조

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)

지정한 리스트를 반환합니다. 비공개 리스트는 현재 인증된 사용자가 해당 리스트를 소유 중일 경우에만 결과에 표시됩니다.

매개변수
  • list_id – 리스트의 ID. (숫자형)

  • slug – 숫자형 ID값 대신, 슬러그(slug)값으로 리스트를 식별할 수 있습니다. 이렇게 하려면, owner_id 또는 owner_screen_name 매개변수를 사용해 목록 소유자를 지정해야만 합니다.

  • owner_screen_name – 슬러그(slug)값으로 지정한 리스트 소유자의 screen_name입니다.

  • owner_id – 슬러그(slug)값으로 지정한 리스트 소유자의 ID값입니다.

반환값

반환 형식

List

참조

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 설정을 이용하세요.

매개변수
  • list_id – 리스트의 ID. (숫자형)

  • slug – 숫자형 ID값 대신, 슬러그(slug)값으로 리스트를 식별할 수 있습니다. 이렇게 하려면, owner_id 또는 owner_screen_name 매개변수를 사용해 목록 소유자를 지정해야만 합니다.

  • owner_screen_name – 슬러그(slug)값으로 지정한 리스트 소유자의 screen_name입니다.

  • owner_id – 슬러그(slug)값으로 지정한 리스트 소유자의 ID값입니다.

  • since_id – 지정한 ID보다 더 큰 ID값을 가지는 객체(즉, 지정한 객체보다 더 최근의 객체)만을 반환함.

  • max_id – 지정한 ID보다 더 작은 ID값을 가지는 객체(즉, 지정한 객체보다 더 이전의 객체)만을 반환함.

  • count – 각 페이지당 보여질 결과 수.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • include_rts – 반환된 리스트 타임라인에 (존재할 경우) 리트윗을 반환할지의 여부를 나타내는 boolean값입니다. 리트윗된 트윗의 출력 형식은 home_timeline에서의 그것과 동일합니다.

반환값

반환 형식

List[Status]

참조

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)

지정한 리스트를 구독 중인 사람(구독자)을 반환합니다. 비공개 리스트는 현재 인증된 사용자가 해당 리스트를 소유 중일 경우에만. 구독자를 볼 수 있습니다.

버전 4.0에서 변경: Renamed from API.list_subscribers

매개변수
  • list_id – 리스트의 ID. (숫자형)

  • slug – 숫자형 ID값 대신, 슬러그(slug)값으로 리스트를 식별할 수 있습니다. 이렇게 하려면, owner_id 또는 owner_screen_name 매개변수를 사용해 목록 소유자를 지정해야만 합니다.

  • owner_screen_name – 슬러그(slug)값으로 지정한 리스트 소유자의 screen_name입니다.

  • owner_id – 슬러그(slug)값으로 지정한 리스트 소유자의 ID값입니다.

  • count – 각 페이지당 보여질 결과 수.

  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • skip_status – 트윗(status)을 반환될 사용자 객체에 포함하지 않을지의 여부를 나타내는 boolean값입니다. 기본값은 False(사용자 객체에 포함함).

반환값

반환 형식

List[User]

참조

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)

지정한 사용자가 지정한 리스트를 구독 중인지 확인합니다.

버전 4.0에서 변경: Renamed from API.show_list_subscriber

매개변수
  • owner_screen_name – 슬러그(slug)값으로 지정한 리스트 소유자의 screen_name입니다.

  • owner_id – 슬러그(slug)값으로 지정한 리스트 소유자의 ID값입니다.

  • list_id – 리스트의 ID. (숫자형)

  • slug – 숫자형 ID값 대신, 슬러그(slug)값으로 리스트를 식별할 수 있습니다. 이렇게 하려면, owner_id 또는 owner_screen_name 매개변수를 사용해 목록 소유자를 지정해야만 합니다.

  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • skip_status – 트윗(status)을 반환될 사용자 객체에 포함하지 않을지의 여부를 나타내는 boolean값입니다. 기본값은 False(사용자 객체에 포함함).

예외 발생

NotFound – 해당 사용자가 해당 리스트의 구독자가 아님.

반환값

반환 형식

User

참조

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)

지정한 사용자가 구독 중인 리스트의 목록을 가져옵니다(기본적으로, 페이지당 20개). 단, 지정한 사용자가 소유 중인 리스트는 포함되지 않습니다.

버전 4.0에서 변경: Renamed from API.lists_subscriptions

매개변수
  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • count – 각 페이지당 보여질 결과 수.

  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

반환값

반환 형식

List[List]

참조

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)

현재 인증된 사용자 소유인 리스트를 만듭니다. 계정당 최대 생성 가능 리스트는 1000개임을 유의하시기 바랍니다.

매개변수
  • name – 만들 리스트의 이름.

  • mode – 목록의 공개·비공개를 설정할 수 있는 매개변수. 값은 public (공개) 또는 private (비공개) 둘 중 하나여야 하며, 따로 지정하지 않은 경우, public (공개)으로 간주합니다.

  • description – 만들 리스트의 설명.

반환값

반환 형식

List

참조

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)

지정한 리스트를 삭제합니다. 현재 인증된 사용자가 소유 중인 리스트만 삭제할 수 있습니다.

매개변수
  • owner_screen_name – 슬러그(slug)값으로 지정한 리스트 소유자의 screen_name입니다.

  • owner_id – 슬러그(slug)값으로 지정한 리스트 소유자의 ID값입니다.

  • list_id – 리스트의 ID. (숫자형)

  • slug – 숫자형 ID값 대신, 슬러그(slug)값으로 리스트를 식별할 수 있습니다. 이렇게 하려면, owner_id 또는 owner_screen_name 매개변수를 사용해 목록 소유자를 지정해야만 합니다.

반환값

반환 형식

List

참조

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명입니다.

매개변수
  • list_id – 리스트의 ID. (숫자형)

  • slug – 숫자형 ID값 대신, 슬러그(slug)값으로 리스트를 식별할 수 있습니다. 이렇게 하려면, owner_id 또는 owner_screen_name 매개변수를 사용해 목록 소유자를 지정해야만 합니다.

  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • owner_screen_name – 슬러그(slug)값으로 지정한 리스트 소유자의 screen_name입니다.

  • owner_id – 슬러그(slug)값으로 지정한 리스트 소유자의 ID값입니다.

반환값

반환 형식

List

참조

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명입니다.

매개변수
  • list_id – 리스트의 ID. (숫자형)

  • slug – 숫자형 ID값 대신, 슬러그(slug)값으로 리스트를 식별할 수 있습니다. 이렇게 하려면, owner_id 또는 owner_screen_name 매개변수를 사용해 목록 소유자를 지정해야만 합니다.

  • user_id – 쉼표(,)로 구분된 사용자 ID값. 1번의 요청에 최대 100개까지만 설정할 수 있습니다.

  • screen_name – 쉼표(,)로 구분된 screen_name값. 1번의 요청에 최대 100개까지만 설정할 수 있습니다.

  • owner_screen_name – 슬러그(slug)값으로 지정한 리스트 소유자의 screen_name입니다.

  • owner_id – 슬러그(slug)값으로 지정한 리스트 소유자의 ID값입니다.

반환값

반환 형식

List

참조

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)

지정한 사용자를 리스트 구성원에서 제거합니다.현재 인증된 사용자가 소유한 리스트에만 가능하며, 리스트 구성원의 제한은 5,000명입니다.

매개변수
  • list_id – 리스트의 ID. (숫자형)

  • slug – 숫자형 ID값 대신, 슬러그(slug)값으로 리스트를 식별할 수 있습니다. 이렇게 하려면, owner_id 또는 owner_screen_name 매개변수를 사용해 목록 소유자를 지정해야만 합니다.

  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • owner_screen_name – 슬러그(slug)값으로 지정한 리스트 소유자의 screen_name입니다.

  • owner_id – 슬러그(slug)값으로 지정한 리스트 소유자의 ID값입니다.

반환값

반환 형식

List

참조

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명입니다.

매개변수
  • list_id – 리스트의 ID. (숫자형)

  • slug – 숫자형 ID값 대신, 슬러그(slug)값으로 리스트를 식별할 수 있습니다. 이렇게 하려면, owner_id 또는 owner_screen_name 매개변수를 사용해 목록 소유자를 지정해야만 합니다.

  • user_id – 쉼표(,)로 구분된 사용자 ID값. 1번의 요청에 최대 100개까지만 설정할 수 있습니다.

  • screen_name – 쉼표(,)로 구분된 screen_name값. 1번의 요청에 최대 100개까지만 설정할 수 있습니다.

  • owner_screen_name – 슬러그(slug)값으로 지정한 리스트 소유자의 screen_name입니다.

  • owner_id – 슬러그(slug)값으로 지정한 리스트 소유자의 ID값입니다.

반환값

반환 형식

List

참조

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)

현재 인증된 사용자로서 지정한 리스트를 구독합니다.

매개변수
  • owner_screen_name – 슬러그(slug)값으로 지정한 리스트 소유자의 screen_name입니다.

  • owner_id – 슬러그(slug)값으로 지정한 리스트 소유자의 ID값입니다.

  • list_id – 리스트의 ID. (숫자형)

  • slug – 숫자형 ID값 대신, 슬러그(slug)값으로 리스트를 식별할 수 있습니다. 이렇게 하려면, owner_id 또는 owner_screen_name 매개변수를 사용해 목록 소유자를 지정해야만 합니다.

반환값

반환 형식

List

참조

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)

현재 인증된 사용자로서 지정한 리스트를 구독 해제합니다.

매개변수
  • list_id – 리스트의 ID. (숫자형)

  • slug – 숫자형 ID값 대신, 슬러그(slug)값으로 리스트를 식별할 수 있습니다. 이렇게 하려면, owner_id 또는 owner_screen_name 매개변수를 사용해 목록 소유자를 지정해야만 합니다.

  • owner_screen_name – 슬러그(slug)값으로 지정한 리스트 소유자의 screen_name입니다.

  • owner_id – 슬러그(slug)값으로 지정한 리스트 소유자의 ID값입니다.

반환값

반환 형식

List

참조

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)

지정한 리스트를 수정(update)합니다. 현재 인증된 사용자가 소유 중인 리스트만 수정(update)이 가능합니다.

매개변수
  • list_id – 리스트의 ID. (숫자형)

  • slug – 숫자형 ID값 대신, 슬러그(slug)값으로 리스트를 식별할 수 있습니다. 이렇게 하려면, owner_id 또는 owner_screen_name 매개변수를 사용해 목록 소유자를 지정해야만 합니다.

  • name – 리스트의 새 이름.

  • mode – 목록의 공개·비공개를 설정할 수 있는 매개변수. 값은 public (공개) 또는 private (비공개) 둘 중 하나여야 하며, 따로 지정하지 않은 경우, public (공개)으로 간주합니다.

  • description – 리스트의 새 설명.

  • owner_screen_name – 슬러그(slug)값으로 지정한 리스트 소유자의 screen_name입니다.

  • owner_id – 슬러그(slug)값으로 지정한 리스트 소유자의 ID값입니다.

반환값

반환 형식

List

참조

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 목록(array)을 반환합니다.

버전 4.0에서 변경: Renamed from API.followers_ids

매개변수
  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

  • stringify_ids – ID를 문자열로 반환하도록 설정.

  • count – 각 페이지당 보여질 결과 수.

반환값

반환 형식

List[int]

참조

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)

지정한 사용자의 팔로워를 최근 순으로 반환합니다. ID값이나 screen_name값으로 특정 사용자를 지정하지 않은 경우, 현재 인증된 사용자를 기준으로 결과값을 반환합니다.

버전 4.0에서 변경: Renamed from API.followers

매개변수
  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

  • count – 각 페이지당 보여질 결과 수.

  • skip_status – 트윗(status)을 반환될 사용자 객체에 포함하지 않을지의 여부를 나타내는 boolean값입니다. 기본값은 False(사용자 객체에 포함함).

  • include_user_entities – False로 설정하면 사용자 객체 노드를 포함하지 않음. 기본값은 True.

반환값

반환 형식

List[User]

참조

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 목록(array)을 반환합니다.

버전 4.0에서 변경: Renamed from API.friends_ids

매개변수
  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

  • stringify_ids – ID를 문자열로 반환하도록 설정.

  • count – 각 페이지당 보여질 결과 수.

반환값

반환 형식

List[int]

참조

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)

지정한 사용자가 팔로우 중인 사용자(user’s friends)를, 한 번에 100명씩 반환합니다. 사용자를 따로 지정하지 않으면, 현재 인증된 사용자 기준 결과를 반환합니다.

버전 4.0에서 변경: Renamed from API.friends

매개변수
  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

  • count – 각 페이지당 보여질 결과 수.

  • skip_status – 트윗(status)을 반환될 사용자 객체에 포함하지 않을지의 여부를 나타내는 boolean값입니다. 기본값은 False(사용자 객체에 포함함).

  • include_user_entities – False로 설정하면 사용자 객체 노드를 포함하지 않음. 기본값은 True.

반환값

반환 형식

List[User]

참조

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 목록을 반환합니다.

버전 4.0에서 변경: Renamed from API.friendships_incoming

매개변수
  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

  • stringify_ids – ID를 문자열로 반환하도록 설정.

반환값

반환 형식

List[int]

참조

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)

최대 100개의 요소로 이루어진 screen_name나 user_name의 목록을 이용해, 현재 인증된 사용자와 해당 목록의 사용자와의 관계를 목록으로 반환합니다.

매개변수
  • screen_name – screen_name의 목록. 한 번에 최대 100명에 대해서만 요청 가능합니다.

  • user_id – user_id의 목록. 한 번에 최대 100명에 대해서만 요청 가능합니다.

반환값

반환 형식

List[Relationship]

참조

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_id 목록을 반환합니다.

매개변수

stringify_ids – ID를 문자열로 반환하도록 설정.

반환값

반환 형식

List[int]

참조

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)

현재 인증된 사용자가 팔로우 요청을 보낸 (비공개 계정인) 사용자들의 목록을 반환합니다.

버전 4.0에서 변경: Renamed from API.friendships_outgoing

매개변수
  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

  • stringify_ids – ID를 문자열로 반환하도록 설정.

반환값

반환 형식

List[int]

참조

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)

지정한 두 사용자의 관계에 대한 자세한 정보를 반환합니다.

버전 4.0에서 변경: Renamed from API.show_friendship

매개변수
  • source_id – 주 대상(subject) 사용자의 user_id.

  • source_screen_name – 주 대상(subject) 사용자의 screen_name.

  • target_id – 부 대상(target) 사용자의 user_id.

  • target_screen_name – 부 대상(target) 사용자의 screen_name.

반환값

반환 형식

Friendship

참조

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)

요청당 최대 100명의 사용자에 대해, 데이터가 채워진(Fully-Hydrated) 사용자 객체를 반환합니다.

이 메서드를 사용할 때 몇 가지 알아두어야 하는 것이 있습니다.

  • 비공개 계정인 사용자의 최근 트윗(Recent status)을 보려면 (현재 인증된 사용자가) 해당 사용자를 팔로우하고 있는 상태여야 합니다. 팔로우 상태가 아닐 경우, 해당 사용자의 트윗은 결과에서 제외되게 됩니다.

  • 사용자 ID값이나 screen_name의 순서가 반환받은 목록에서의 순서와 일치하지 않을 수 있습니다.

  • 지정한 사용자를 찾을 수 없거나(Unknown), 해당 사용자의 계정이 정지되었거나 삭제된 경우 반환되는 목록에 해당 사용자가 포함되지 않습니다.

  • 검색 조건에 부합하여 반환할 사용자 객체가 하나도 없는 경우, HTTP 404 예외가 발생합니다.

매개변수
  • screen_name – screen_name의 목록. 한 번에 최대 100명에 대해서만 요청 가능합니다.

  • user_id – user_id의 목록. 한 번에 최대 100명에 대해서만 요청 가능합니다.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • tweet_modecompat (호환 트윗)과 extended (확장 트윗) 중 하나로 입력합니다. 각각 순서대로 140자 이상 트윗에 대해 〈호환 모드’와 〈확장 모드’를 제공합니다.

반환값

반환 형식

List[User]

참조

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)

트위터의 〈사용자 검색〉 과 동일한 검색 기능을 실행합니다. 이 API를 이용한 검색은, 트위터에서 제공하는 것과 동일한 검색 결과를 반환합니다. 단, 최대 첫 1000개의 결과만 가져올 수 있습니다.

매개변수
  • q – 사용자 검색에 사용할 검색어

  • page – 검색 결과의 페이지. 참고: 페이지 수에 제한이 있음.

  • count – 각 페이지당 보여질 결과 수.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

반환값

반환 형식

List[User]

참조

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)

지정한 사용자의 정보를 반환합니다.

매개변수
  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

반환값

반환 형식

User

참조

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)

지정한 사용자를 팔로우(Make friendship)합니다.

매개변수
  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • follow – 해당 사용자를 팔로우함과 동시에 〈모든 트윗에 대해 알림 받기〉(이하 트윗 알림)를 설정합니다.

반환값

반환 형식

User

참조

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)

지정한 사용자를 언팔로우(Destroy friendship)합니다.

매개변수
  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

반환값

반환 형식

User

참조

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)

지정한 사용자의 트윗 알림 및 리트윗을 켜거나 끕니다.

매개변수
  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • device – 대상 사용자의 트윗 알림 켜거나 끄기.

  • retweets – 대상 사용자의 리트윗 보기 켜거나 끄기.

반환값

반환 형식

Friendship

참조

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

계정 설정 및 프로필 관리

API.get_settings()

현재 인증된 사용자에 대한 설정값(나를 위한 트렌드, 지역 및 방해금지 시간 등)을 반환합니다.

반환값

JSON

반환 형식

dict

참조

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)

사용자 자격 증명이 올바른지 확인합니다.

매개변수
  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • skip_status – 트윗(status)을 반환될 사용자 객체에 포함하지 않을지의 여부를 나타내는 boolean값입니다. 기본값은 False(사용자 객체에 포함함).

  • include_emailtrue 로 설정하면, 사용자 객체에 이메일 주소가 문자열 형태로 반환됩니다.

예외 발생

Unauthorized – 사용자 인증에 실패한 경우.

반환값

반환 형식

User

참조

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

현재 인증된 사용자가 저장한 검색어의 목록을 반환합니다.

버전 4.0에서 변경: Renamed from API.saved_searches

반환값

반환 형식

List[SavedSearch]

참조

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

현재 인증된 사용자가 소유 중인, ID로 지정한 〈저장된 검색어’에 대한 정보를 반환합니다.

매개변수

id – 검색할 〈저장된 검색어’의 고유 ID값.

반환값

반환 형식

SavedSearch

참조

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)

지정한 사용자의 프로필 배너를, 여러 크기로 이용할 수 있도록 반환합니다.지정한 사용자가 프로필 배너를 업로드하지 않았을 경우, HTTP 404 예외가 발생합니다.

각 크기별 프로필 배너는 PNG 형식입니다.

매개변수
  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

반환값

JSON

반환 형식

dict

참조

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

현재 인증된 사용자의 프로필 배너를 제거합니다.

참조

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)

현재 인증된 사용자의 설정값을 변경합니다.

매개변수
  • sleep_time_enabledtrue, t, 또는 1 로 설정하면, 방해 금지 모드(sleep time)를 활성화합니다. 방해 금지 시간대에는 사용자에게 푸시 알림 또는 SMS 알림을 보내지 않습니다.

  • start_sleep_time – 방해 금지 모드를 자동 활성화할 시간대입니다. 이 매개변수의 형식은 ISO 8601 형식(즉, hh-mm 형식)으로 제공되어야 하며, 시간대는 현재 사용자의 time_zone 설정과 동일한 시간대로 설정됩니다.

  • end_sleep_time – 방해 금지 모드를 자동 비활성화할 시간대입니다. 이 매개변수의 형식은 ISO 8601 형식(즉, hh-mm 형식)으로 제공되어야 하며, 시간대는 현재 사용자의 time_zone 설정과 동일한 시간대로 설정됩니다.

  • time_zone – 현재 사용의 표준 시간대를 설정합니다. 표준 시간대의 이름은 Rails의 TimeZone 이름 을 따라야 합니다. (예: 한국의 경우 《Seoul》)

  • trend_location_woeid – 나를 위한 트렌드 기준을 설정할 위치의 야후 Where On Earth ID값.

  • lang – 사용자에 대해 트위터가 보여주어야 하는 언어. 언어는 반드시 ISO 639-1 국제 표준을 따라 두 글자로 명시되어야만 합니다.

반환값

JSON

반환 형식

dict

참조

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)

사용자가 설정 페이지의 《계정》 탭에서 설정 가능한 값들을 수정합니다.

매개변수
  • name – 사용자의 이름(닉네임).

  • url – 프로필에 연결할 URL. http:// 를 붙이지 않은 경우 자동으로 이를 앞에 붙입니다.

  • location – 사용자가 위치한 도시 및 국가. 내용은 정규화되거나 지리적 코드화되지 않았습니다(즉, 자유로이 입력할 수 있습니다).

  • description – 사용자의 자기소개(바이오).

  • profile_link_color – 현재 인증된 사용자의 프로필 페이지에 사용되는 링크의 색깔을 16진수 값으로 설정합니다. 유효한 16진수 값이어야 하며, 3자 또는 6자일 수 있습니다(예: F00 또는 FCACD3)

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • skip_status – 트윗(status)을 반환될 사용자 객체에 포함하지 않을지의 여부를 나타내는 boolean값입니다. 기본값은 False(사용자 객체에 포함함).

반환값

반환 형식

User

참조

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)

현재 인증된 사용자의 배너 이미지를 업로드합니다.

매개변수
  • filename – 업로드할 이미지의 이름. file 을 따로 지정하지 않으면 이 파일이 자동으로 열립니다.

  • file – 파일 객체로, filename 를 직접 여는 것 대신 사용됩니다. 물론 MIME 타입 감지 및 POST 데이터 형식의 필드로 filename 가 필요하기는 합니다.

  • width – 배너로 사용할 이미지의 너비값을 픽셀 단위로 설정합니다. height, offset_left, offset_top 과 함께 사용해, 업로드 중인 이미지에서 어떤 영역을 사용할 것인지를 정할 수 있습니다.

  • height – 배너로 사용할 이미지의 높이값을 픽셀 단위로 설정합니다. width, offset_left, offset_top 과 함께 사용해, 업로드 중인 이미지에서 어떤 영역을 사용할 것인지를 정할 수 있습니다.

  • offset_left – 배너로 사용할 이미지가 원본 이미지의 맨 왼쪽에서 얼마나 떨어져 있는지를 픽셀 단위로 설정합니다. width, height, offset_top 과 함께 사용해, 업로드 중인 이미지에서 어떤 영역을 사용할 것인지를 정할 수 있습니다.

  • offset_top – 배너로 사용할 이미지가 원본 이미지의 맨 위쪽에서 얼마나 떨어져 있는지를 픽셀 단위로 설정합니다. width, height, offset_top 과 함께 사용해, 업로드 중인 이미지에서 어떤 영역을 사용할 것인지를 정할 수 있습니다.

참조

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)

현재 인증된 사용자의 프로필 이미지(인장)를 바꿉니다. 올바른 파일 형식은 GIF, JPG, PNG 입니다.

매개변수
  • filename – 업로드할 이미지의 이름. file 을 따로 지정하지 않으면 이 파일이 자동으로 열립니다.

  • file – 파일 객체로, filename 를 직접 여는 것 대신 사용됩니다. 물론 MIME 타입 감지 및 POST 데이터 형식의 필드로 filename 가 필요하기는 합니다.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • skip_status – 트윗(status)을 반환될 사용자 객체에 포함하지 않을지의 여부를 나타내는 boolean값입니다. 기본값은 False(사용자 객체에 포함함).

반환값

반환 형식

User

참조

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

현재 인증된 사용자의 〈저장된 검색어’를 만듭니다.

매개변수

query – 저장할 검색어(또는 검색 조건).

반환값

반환 형식

SavedSearch

참조

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

현재 인증된 사용자의 〈저장된 검색어’를 삭제합니다. 반드시 해당 검색어의 고유 ID값이 현재 인증된 사용자의 소유여야 합니다.

매개변수

id – 삭제할 검색어의 고유 ID값.

반환값

반환 형식

SavedSearch

참조

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값의 배열 꼴로 반환합니다.

버전 4.0에서 변경: Renamed from API.blocks_ids

매개변수
  • stringify_ids – ID를 문자열로 반환하도록 설정.

  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

반환값

반환 형식

List[int]

참조

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)

현재 인증된 사용자가 차단한 사용자를 사용자 객체의 배열 꼴로 반환합니다.

버전 4.0에서 변경: Renamed from API.blocks

매개변수
  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • skip_status – 트윗(status)을 반환될 사용자 객체에 포함하지 않을지의 여부를 나타내는 boolean값입니다. 기본값은 False(사용자 객체에 포함함).

  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

반환값

반환 형식

List[User]

참조

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값의 배열 꼴로 반환합니다.

버전 4.0에서 변경: Renamed from API.mutes_ids

매개변수
  • stringify_ids – ID를 문자열로 반환하도록 설정.

  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

반환값

반환 형식

List[int]

참조

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)

현재 인증된 사용자가 뮤트한 사용자를 사용자 객체의 배열 꼴로 반환합니다.

버전 4.0에서 변경: Renamed from API.mutes

매개변수
  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • skip_status – 트윗(status)을 반환될 사용자 객체에 포함하지 않을지의 여부를 나타내는 boolean값입니다. 기본값은 False(사용자 객체에 포함함).

반환값

반환 형식

List[User]

참조

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)

현재 인증된 사용자로서 지정한 사용자를 차단합니다. 차단된 사용자는 현재 인증된 사용자의 타임라인에 표시되지 않으며, 멘션도 불가능합니다(단, 다른 사람이 리트윗한 경우 보일 수 있습니다). 차단하면, 모든 팔로우 및 팔로잉 관계는 자동적으로 해제됩니다.

매개변수
  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • skip_status – 트윗(status)을 반환될 사용자 객체에 포함하지 않을지의 여부를 나타내는 boolean값입니다. 기본값은 False(사용자 객체에 포함함).

반환값

반환 형식

User

참조

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값으로 지정한 사용자를 차단 해제합니다.

매개변수
  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • include_entities – False로 설정하면 엔티티 노드가 포함되지 않음. 기본값은 True.

  • skip_status – 트윗(status)을 반환될 사용자 객체에 포함하지 않을지의 여부를 나타내는 boolean값입니다. 기본값은 False(사용자 객체에 포함함).

반환값

반환 형식

User

참조

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)

현재 인증된 사용자로서 지정한 사용자를 뮤트합니다.

매개변수
  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

반환값

반환 형식

User

참조

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값으로 지정한 사용자를 언뮤트(뮤트 해제)합니다.

매개변수
  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

반환값

반환 형식

User

참조

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)

지정한 사용자를 트위터에 스팸으로 신고합니다.

매개변수
  • screen_name – 사용자 아이디(예: @pinkrabbit412에서의 pinkrabbit412 ). 어떤 값이 유효한 사용자 아이디인지, 유효한 일련번호인지를 확실히 해야 할 때 도움이 됩니다.

  • user_id – 특정 사용자의 일련번호값.user_name와 screen_name이 같을 때, 이 매개변수를 사용하면 좋습니다.

  • perform_block – 신고할 사용자를 차단할지의 여부를 나타내는 boolean 값. 기본값은 True.

반환값

반환 형식

User

참조

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

쪽지(DM, Direct Message)

전송 및 수신 이벤트

API.delete_direct_message(id)

필수 입력인 ID값을 이용해 지정한 쪽지를 삭제합니다. 현재 인증된 사용자가 해당 쪽지의 수신자여야 합니다.쪽지는 나에게서만 삭제되며, 다른 대화 구성원들은 해당 메세지에 접근할 수 있습니다.

버전 4.0에서 변경: Renamed from API.destroy_direct_message

매개변수

id – 삭제할 쪽지의 고유 ID값.

참조

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일 이내의 모든 쪽지를 반환합니다. 받은 순서의 역순으로 정렬됩니다. (즉, 나중에 받은 쪽지가 먼저 반환됩니다.)

버전 4.0에서 변경: Renamed from API.list_direct_messages

매개변수
  • count – 각 페이지당 보여질 결과 수.

  • cursor – 결과를 페이지로 나누며, 페이징을 시작하려면 -1 값을 입력합니다. 응답 내용의 next_cursor와 previous_cursor 속성의 반환값을 입력해, 목록의 페이지를 앞뒤로 옮길 수 있습니다.

반환값

반환 형식

List[DirectMessage]

참조

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

API.get_direct_message(id)

지정한 쪽지를 반환합니다.

매개변수

id – 반환받을 쪽지의 고유 ID값.

반환값

반환 형식

DirectMessage

참조

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)

현재 인증된 사용자로서 지정한 사용자에게 쪽지를 보냅니다.

매개변수
  • recipient_id – 쪽지를 받을 사용자의 ID.

  • text – 보낼 쪽지의 본문. 최대 10,000자까지 작성할 수 있습니다.

  • quick_reply_options – 빠른 답장 옵션 객체의 목록(최대 20개까지 가능).

  • attachment_type – 첨부파일의 종류. media(미디어)나 location(위치)가 될 수 있습니다.

  • attachment_media_id – 쪽지에 연결할 미디어의 ID값. 한 쪽지에는 하나의 미디어만 연결할 수 있습니다.

  • ctas – 1~3개의 CTA(Call-to-action)버튼 객체. 필수값은 아님.

반환값

반환 형식

DirectMessage

참조

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

Typing indicator and read receipts

API.indicate_direct_message_typing(recipient_id)

Displays a visual typing indicator in the recipient’s Direct Message conversation view with the sender. Each request triggers a typing indicator animation with a duration of ~3 seconds.

버전 4.9에 추가.

매개변수

recipient_id – The user ID of the user to receive the typing indicator.

참조

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/typing-indicator-and-read-receipts/api-reference/new-typing-indicator

API.mark_direct_message_read(last_read_event_id, recipient_id)

Marks a message as read in the recipient’s Direct Message conversation view with the sender.

버전 4.9에 추가.

매개변수
  • last_read_event_id – The message ID of the most recent message to be marked read. All messages before it will be marked read as well.

  • recipient_id – The user ID of the user the message is from.

참조

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/typing-indicator-and-read-receipts/api-reference/new-read-receipt

미디어

미디어 업로드

API.get_media_upload_status(media_id)

청크 전송법을 이용하는 미디어의 전송률을 확인합니다. 업로드가 완료된 이후라면 이 미디어의 media_id 값을 이용해 트윗할 수 있습니다.

매개변수

media_id – 전송률을 확인할 미디어의 ID값.

반환값

반환 형식

Media

참조

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 포함)에만 적용됩니다. 이미지에 대체 텍스트와 같은 추가 메타데이터를 첨부해야 할 때, 이 엔드포인트를 호출하면 됩니다.

매개변수
  • media_id – 대체 텍스트를 추가할 미디어의 ID값.

  • alt_text – 이미지에 추가할 대체 텍스트 본문.

참조

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)

Use this to upload media to Twitter. This calls either simple_upload() or chunked_upload(). Chunked media upload is automatically used for videos. If chunked is set or the media is a video, wait_for_async_finalize can be specified as a keyword argument to be passed to chunked_upload().

매개변수
  • filename – 업로드할 이미지의 이름. file 을 따로 지정하지 않으면 이 파일이 자동으로 열립니다.

  • file – 파일 객체로, filename 를 직접 여는 것 대신 사용됩니다. 물론 MIME 타입 감지 및 POST 데이터 형식의 필드로 filename 가 필요하기는 합니다.

  • chunked – 미디어를 업로드할 때 청크 전송법을 사용할지의 여부. 영상 미디어는 이 매개변수 값과 관련 없이 청크 전송법을 사용합니다. 기본값은 False.

  • media_category – 미디어가 어떤 방식으로 이용되는지를 나타내는 매개변수. 이 매개변수는 보통 트위터 광고 API와 함께 미디어를 사용해야 할 때 필요합니다.

  • additional_owners – 트윗 또는 카드에서 반환된 미디어의 media_id를 사용할 수 있는 추가 소유자로 지정할 사용자 ID값의 목록입니다. 최대 100명까지 추가 소유자로 지정 가능합니다.

반환값

반환 형식

Media

참조

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

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

이 엔드포인트를 이용해, 트위터에 미디어를 업로드할 수 있습니다. 청크 전송법 엔드포인트를 사용하지 않는 엔드포인트입니다.

매개변수
  • filename – 업로드할 이미지의 이름. file 을 따로 지정하지 않으면 이 파일이 자동으로 열립니다.

  • file – 파일 객체로, filename 를 직접 여는 것 대신 사용됩니다. 물론 MIME 타입 감지 및 POST 데이터 형식의 필드로 filename 가 필요하기는 합니다.

  • media_category – 미디어가 어떤 방식으로 이용되는지를 나타내는 매개변수. 이 매개변수는 보통 트위터 광고 API와 함께 미디어를 사용해야 할 때 필요합니다.

  • additional_owners – 트윗 또는 카드에서 반환된 미디어의 media_id를 사용할 수 있는 추가 소유자로 지정할 사용자 ID값의 목록입니다. 최대 100명까지 추가 소유자로 지정 가능합니다.

반환값

반환 형식

Media

참조

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)

Use this to upload media to Twitter. This uses the chunked upload endpoints and calls chunked_upload_init(), chunked_upload_append(), and chunked_upload_finalize(). If wait_for_async_finalize is set, this calls get_media_upload_status() as well.

매개변수
  • filename – 업로드할 이미지의 이름. file 을 따로 지정하지 않으면 이 파일이 자동으로 열립니다.

  • file – 파일 객체로, filename 를 직접 여는 것 대신 사용됩니다. 물론 MIME 타입 감지 및 POST 데이터 형식의 필드로 filename 가 필요하기는 합니다.

  • file_type – 업로드되는 미디어의 MIME 타입.

  • wait_for_async_finalize – 트위터 API가 미디어 관련 처리를 완료할 때까지 기다릴지의 여부. 기본값은 True.

  • media_category – 미디어가 어떤 방식으로 이용되는지를 나타내는 매개변수. 이 매개변수는 보통 트위터 광고 API와 함께 미디어를 사용해야 할 때 필요합니다.

  • additional_owners – 트윗 또는 카드에서 반환된 미디어의 media_id를 사용할 수 있는 추가 소유자로 지정할 사용자 ID값의 목록입니다. 최대 100명까지 추가 소유자로 지정 가능합니다.

반환값

반환 형식

Media

참조

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)

이 엔드포인트를 사용해, 미디어 파일의 청크(연속된 바이트 범위로)를 업로드합니다.

매개변수
  • media_id – 첫 청크에서 반환한 media_id.

  • media – 업로드할 바이너리 파일. 파일 크기는 5MB보다 작거나 같아야 합니다.

  • segment_index – 이 청크의 순서. 0부터 999 사이의 정수값이어야 하며, 첫 청크는 0의 값을 가집니다.두 번째 청크는 1, 세 번째 청크는 2의 값을 가지며, 이하상동입니다.

참조

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

API.chunked_upload_finalize(media_id)

이 엔드포인트를 사용해, 청크 전송법으로 미디어를 전송하는 것을 끝마쳤음을 알립니다. 단, 응답에 processing_info 필드가 포함되어 있는 경우, 트윗을 작성하기 전 해당 작업의 상태를 확인하고, 성공했다는 결과를 반환하기 전까지 기다려야 할 수도 있습니다.

매개변수

media_id – 첫 청크에서 반환한 media_id.

반환값

반환 형식

Media

참조

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)

이 엔드포인트를 사용해, 청크 전송법을 이용하는 컨텐츠의 첫 청크를 업로드합니다.

매개변수
  • total_bytes – 바이트로 업로드되는 미디어의 크기.

  • media_type – 업로드되는 미디어의 MIME 타입.

  • media_category – 미디어가 어떤 방식으로 이용되는지를 나타내는 매개변수. 이 매개변수는 보통 트위터 광고 API와 함께 미디어를 사용해야 할 때 필요합니다.

  • additional_owners – 트윗 또는 카드에서 반환된 미디어의 media_id를 사용할 수 있는 추가 소유자로 지정할 사용자 ID값의 목록입니다. 최대 100명까지 추가 소유자로 지정 가능합니다.

반환값

반환 형식

Media

참조

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

위치 및 지리 정보

특정 장소에 대한 정보 가져오기

API.geo_id(place_id)

place_id 로 지정한 장소에 대한 자세한 정보를 제공합니다.

매개변수

place_id – 특정 장소에 대한 유효한 트위터 고유 ID값.

반환값

반환 형식

Place

참조

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

현재 위치로부터 가까운 장소 가져오기

API.reverse_geocode(lat, long, *, accuracy, granularity, max_results)

주어진 위도 및 경도를 바탕으로, place_id 형태로 트윗을 작성할 때 사용할 수 있는 특정 장소를 최대 20개까지 반환합니다.

이 요청은 정보성 호출로 볼 수 있고, 지리 정보에 대한 일반적인 결과값을 제공합니다.

매개변수
  • lat – 특정 장소의 위도값.

  • long – 특정 장소의 경도값.

  • accuracy – 얼마나 넓은 지역을 검색할지를 지정하는 매개변수.기본적으로 미터(m) 단위 반지름으로 인식되나, 접미어 ft 를 통해 피트(ft) 단위의 반지름으로 인식되게 할 수 있습니다. 기본값은 0(0m)입니다.

  • granularity – 기본값은 neighborhood 지만, city 로도 설정할 수 있습니다.

  • max_results – 반환할 최대 결과 수에 대한 힌트값. 꼭 지켜지지 않을 수도 있습니다.

반환값

반환 형식

List[Place]

참조

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

This is the recommended method to use find places that can be attached to update_status(). Unlike 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.

이 메서드의 특정 매개변수는 다른 매개변수가 존재할 때만 필요해집니다. 예를 들어, lat (위도값)은 long (경도값)이 제공된 경우 반드시 필요한 값이 되고, 반대로 long (경도값)은 lat (위도값)이 제공된 경우 반드시 필요한 값이 됩니다.

버전 4.0에서 변경: Renamed from API.geo_search

매개변수
  • lat – 이 트윗이 가리킬 위치의 위도. -90.0 ~ +90.0 (북반구가 양수값) 범위 밖의 값은 무시되며, 아래의 long 매개변수가 지정되지 않은 경우에도 무시됩니다.

  • long – 이 트윗이 가리킬 위치의 경도. -180.0 ~ +180.0 (동쪽이 양수값) 범위 밖의 값, 숫자 이외의 값이 입력될 경우 무시되며, geo_enabled 가 비활성화 되었거나, 위의 lat 매개변수가 지정되지 않은 경우에도 전달된 값이 무시됩니다.

  • query – 자유 형식의 텍스트형 쿼리이며, 이름으로 가장 가까운 위치를 찾는데 적합합니다.

  • ip – IP 주소. 검색 위치의 기준을 설정할 때 사용됩니다.

  • granularity – 반환할 장소 유형의 최소 세분화이며, 다음 중 하나여야 합니다: neighborhood, city, admincountry. 따로 지정하지 않는 경우, neighborhood 로 지정한 것으로 간주합니다.예로, 이를 city 로 설정하면 city, admincountry 유형의 장소가 검색됩니다.

  • max_results – 반환받을 결과 수에 대한 힌트값입니다. 원본 결과 수는 이 힌트값과 같지 않을 수 있으며, 〈가까운 장소’꼴의 결과를 몇 개나 반환할지를 정하는 매개변수값입니다. 즉, 사용자에게 표시할 결과 수만큼의 값을 지정하는 것이 이상적입니다.

반환값

반환 형식

List[Place]

참조

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

개발자 도구

트위터 지원 언어 가져오기

API.supported_languages()

트위터에서 지원하는 언어 코드와 함께, 지원 언어의 목록을 반환합니다.

언어 코드 포맷은 국제 표준 중 ISO 639-1 alpha-2 (ko), ISO 639-3 alpha-3(kor) 및 ISO 639-1 alpha-2와 ISO 3166-1 alpha-2(ko-kr) 를 따릅니다.

반환값

JSON

반환 형식

dict

참조

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

트위터 API 호출 제한 확인하기

API.rate_limit_status(*, resources)

지정한 리소스 패밀리의 호출 제한 관련 정보를 반환합니다. application-only 인증 방식 사용 시, 이 메서드는 해당 인증 관련 API 호출 제한 정보를 반환합니다.

매개변수

resources – 현재의 API 호출 제한을 확인할, 쉼표(,)로 구분된 리소스 패밀리의 목록입니다.

반환값

JSON

반환 형식

dict

참조

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

각주

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