Odniesienia do API

Ta strona zawiera podstawową dokumentację do modułu Tweepy.

tweepy.api — Twitter API wrapper

class API([auth_handler=None][, host='api.twitter.com'][, search_host='search.twitter.com'][, cache=None][, api_root='/1'][, search_root=''][, retry_count=0][, retry_delay=0][, retry_errors=None][, timeout=60][, parser=ModelParser][, compression=False][, wait_on_rate_limit=False][, wait_on_rate_limit_notify=False][, proxy=None])

Ta klasa dostarcza wrapper dla API tak jak dostarczono to przez Twitter. Funkcje dostarczone w tej klasie są zapisane poniżej.

Parametry:
  • auth_handler – program obsługi autentykacji, który zostanie użyty
  • host – generalny host API
  • search_host – przeszukaj hosta API
  • cache – pamięć podręczna backend, która zostanie użyta
  • api_root – generalna ścieżka korzenia API
  • search_root – przeszukaj ścieżkę korzenia API
  • retry_count – domyślna liczba powtórzeń gdy wystąpi błąd
  • retry_delay – liczba sekund oczekiwania pomiędzy powtórzeniami
  • retry_errors – który kod statusu HTTP zostanie użyty do powtórzenia
  • timeout – Maksymalna ilość czasu oczekiwania na odpowiedź od Twitter
  • parser – Obiekt, który zostanie użyty do analizy odpowiedzi od Twitter
  • compression – Czy do żądań ma zostać użyta kompresja GZIP
  • wait_on_rate_limit – Czy automatycznie oczekiwać na wyczerpanie limitów wskaźników
  • wait_on_rate_limit_notify – czy wyświetlać notyfikacje, gdy Tweepy oczekuje na wyczerpanie limitów wskaźników
  • proxy – Pełen URL proxy HTTPS, które jest użyte do połączenia z Twitter.

Metody osi czasu

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

Zwraca 20 ostatnich statusów w tym retweety zapostowane przez zuwierzytelnionego użytkownika i jego znajomych. Jest to to samo co /timeline/home.

Parametry:
  • count – Liczba wyników do pobrania na stronę.
  • since_id – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID.
  • max_id – Zwraca tylko statusy z ID mniejszym (tzn. starszym) lub równym określonemu ID.
  • trim_user – Boolean wskazujacy czy dostarczyć ID użytkowników zamiast kompletnych obiektów user. Domyślnie False.
  • exclude_replies – This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count Tweets — this is because the count parameter retrieves that many Tweets before filtering out retweets and replies.
  • include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False.
Typ zwracany:

lista obiektów Status
API.statuses_lookup(id_[, include_entities][, trim_user][, map_][, include_ext_alt_text][, include_card_uri])

Zwraca pełne obiekty Tweet, do 100 tweetow na jedno żądanie. Sprecyzowane w parametrze id_.

Parametry:
  • id_ – Lista ID tweetów do wyszukania, maksymalnie 100
  • include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False.
  • trim_user – Boolean wskazujacy czy dostarczyć ID użytkowników zamiast kompletnych obiektów user. Domyślnie False.
  • map_ – Boolean wskazujący czy zawarte będą tweety, które nie mogą być pokazywane. Domyślnie ustawione jako False.
  • include_ext_alt_text – Jeżeli alt tekst został dodany do którejś z dołączonych jednostek to ten parametr zwróci wartość ext_alt_text w kluczu top-level dla tej jednostki mediów.
  • include_card_uri – Boolean wkazujący czy otrzymany tweet powinien zawierać atrybut card_uri gdy do tweeta dołączona jest karta ads oraz gdy karta jest dołączona używając wartośći card_uri.
Typ zwracany:

lista obiektów Status
API.user_timeline([id/user_id/screen_name][, since_id][, max_id][, count][, page])

Zwraca 20 ostatnich statusów zapostowanych przez zuwierzytelnionego użytkownika lub wyznaczonego użytkownika. Możliwe jest także zażądanie osi czasu innego użytkownika za pomocą parametru id.

Parametry:
  • id – Określa ID lub nazwę wyświetlaną użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • since_id – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID.
  • max_id – Zwraca tylko statusy z ID mniejszym (tzn. starszym) lub równym określonemu ID.
  • count – Liczba wyników do pobrania na stronę.
  • page – Określa którą stronę wyników otrzymać. Uwaga: istnieją limity stronnicowania.
Typ zwracany:

lista obiektów Status
API.retweets_of_me([since_id][, max_id][, count][, page])

Zwraca 20 najnowszych tweetów od zuwierzytelnionego użytkownika, które zostały zretweetowane przez innych.

Parametry:
  • since_id – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID.
  • max_id – Zwraca tylko statusy z ID mniejszym (tzn. starszym) lub równym określonemu ID.
  • count – Liczba wyników do pobrania na stronę.
  • page – Określa którą stronę wyników otrzymać. Uwaga: istnieją limity stronnicowania.
Typ zwracany:

lista obiektów Status
API.mentions_timeline([since_id][, max_id][, count])

Zwraca 20 najnowszych wzmianek, w tym retweety.

Parametry:
  • since_id – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID.
  • max_id – Zwraca tylko statusy z ID mniejszym (tzn. starszym) lub równym określonemu ID.
  • count – Liczba wyników do pobrania na stronę.
Typ zwracany:

lista obiektów Status

Metody statusu

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

Zwraca pojedyńczy status określony przez parametr ID.

Parametry:
  • id – Numeryczne ID statusu.
  • trim_user – Boolean wskazujacy czy dostarczyć ID użytkowników zamiast kompletnych obiektów user. Domyślnie False.
  • include_my_retweet – Boolean wskazujący czy tweety, które zostały zretweetowane przez zuwierzytelnionego użytkownika powinny zawierać dodatkowy węzeł current_user_retweet, który zawiera ID statusu źródłowego dla retweeta.
  • include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False.
  • include_ext_alt_text – Jeżeli alt tekst został dodany do którejś z dołączonych jednostek to ten parametr zwróci wartość ext_alt_text w kluczu top-level dla tej jednostki mediów.
  • include_card_uri – Boolean wkazujący czy otrzymany tweet powinien zawierać atrybut card_uri gdy do tweeta dołączona jest karta ads oraz gdy karta jest dołączona używając wartośći card_uri.
Typ zwracany:

obiekt Status
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][, enable_dmcommands][, fail_dmcommands][, card_uri])

Aktualizuje status zuwierzytelnionego użytkownika.

Dla każdej próby aktualizacji, jej tekst jest porównywany z najnowszym tweetem zuwierzytelnionego użytkownika. Każda próba, której rezultatem był by duplikat, zostanie zablokowana, co spowoduje wystąpienie błędu 403. Użytkownik nie może wysłać tego samego statusu dwa razy pod rząd.

Mimo, że nie jest to limitowane przez API, użytkownik może stworzyć maksymalnie określoną liczbę tweetów za jednym razem. Jeżeli liczba aktualizacji zapostowana przez użytkownika osiągnie aktualny limit, metoda tha zwróci błąd HTTP 403.

Parametry:
  • status – Tekst statusu aktualizacji.
  • in_reply_to_status_id – ID istniejącego statusu dla którego odpowiada aktualizacja. Uwaga: Ten parametr zostanie zignorowany, chyba, że autor tweeta, do którego się odnosi jest wspomniany w ramach tekstu statusu. Tak więc w aktualizacji musisz zawrzeć @username, gdzie username jest autorem wspomnianego tweeta.
  • auto_populate_reply_metadata – Jeżeli ustawione jako true i użyte w in_reply_to_status_id, głowne @mentions będą wyszukane w oryginalnym tweecie i dodane do nowego tweeta. To dołączy @mentions do metaaty istniejącego tweeta wraz z rozwojem łańcucha tweetów, póki nie zostanie osiągnięty limit @mentions. Odpowiedź nie powiedzie się, w przypadkach gdzie oryginalny tweet został usunięty.
  • exclude_reply_user_ids – Gdy użyte z auto_populate_reply_metadata, lista ID użytkowników oddzielona przecinkami zostanie usunięta z wygenerowanego przez serwer prefiksu @mentions na rozszerzonym tweecie. Zauważ, że główne @mention nie mogą być usunięte ponieważ zepsuło by to semantykę in-reply-to-status-id. Próby ich usunięcia będą dyskretnie zignorowane.
  • attachment_url – Aby URL nie był policzony w treść statusu rozszerzonego tweeta, dołacz go jako załącznik. URL ten musi być permalinkiem tweeta lub linkiem Wiadomości Bezpośredniej. Inne nie-twitterowe URL muszą pozostać w tekście statusu. URL przekazane do parametru attachment_url, które nie są przyporządkowane do permalinku tweeta lub Wiadomości Bezpośredniej, nie stworzą tweeta i spowodują wystąpienie wyjątku.
  • media_ids – Lista media_ids powiązanych z tweetem. Jeden tweet może zawierać maksymalnie 4 zdjęcia, 1 animowany GIF lub 1 video
  • possibly_sensitive – Jeżeli prześlesz media tweeta, które mogą zawierać wrażliwy kontent taki jak nagość lub procedury medyczne to ta wartość musi być ustawiona jako true.
  • lat – Szerokość geograficzna lokacji do której odnosi się tweet. Ten parametr zostanie zignorowany, chyba, że znajduje się pomiędzy -90.0 a +90.0 (północ to wartość dodatnia). Zostanie on także zignorowany jeżeli nie ma on dopasowanego parametru długości geograficznej.
  • long – Długość geograficzna do której odnosi się tweet. Poprawne wartości zawieraja się między -180.0 a +180.0 (wschód to wartość dodatnia). Ten parametr zostanie zignorowany jeżeli przekracza ten zakres, nie jest liczbą, gdy geo_enabled jest wyłączone oraz jeżeli nie ma dopasowanego parametru szerokości geograficznej.
  • place_id – Miejsce gdzieś na świecie.
  • display_coordinates – Czy wbić szpilkę w miejsce o dokładnych koordynatach, z których został wysłany Tweet.
  • trim_user – Boolean wskazujacy czy dostarczyć ID użytkowników zamiast kompletnych obiektów user. Domyślnie False.
  • enable_dmcommands – Gdy ustawione jako true, pozwala używać krótkich komend do wysyłania Wiadomości Bezpośrednich jako częśc tekstu statusu do wysłania do użytkownika. Jeżeli ustawione jako false, powyższe rozwiązanie zostanie wyłączone i zawarte zostaną głowne znaki zapostowanego tekstu statusu.
  • fail_dmcommands – Gdy ustawione jako true, powoduje, że jakikolwiek tekst statusu rozpoczęty komendą krótka wywołuje błąd API. Gdy ustawione jako true, pozwala krótkim komendom na zostanie wysłanym w tekście statusu i bycie użytym przez API
  • card_uri – Powiązuje karte reklamową z tweetem używając wartości card_uri z jakiejkolwiek odpowiedzi od karty reklamowej.
Typ zwracany:

obiekt Status
API.update_with_media(filename[, status][, in_reply_to_status_id][, auto_populate_reply_metadata][, lat][, long][, source][, place_id][, file])

Nierekomendowane: używa API.media_upload(). Zaktualizuj status zuwierzytelnionego użytkownika. Statusy ktore są duplikatami lub są za długie będą dyskretnie ignorowane.

Parametry:
  • filename – Nazwa pliku obrazu do wrzucenia. Będzie ona automatycznie otwarta, chyba, że file zostanie określone.
  • status – Tekst statusu aktualizacji.
  • in_reply_to_status_id – ID istniejącego już statusu, dla ktorego aktualizacja jest odpowiedzią.
  • auto_populate_reply_metadata – Czy automatycznie zawierać @wzmianki w metadacie statusu.
  • lat – Szerokość geograficzna do której odnosi się tweet.
  • long – Długość geograficzna do której odnosi się tweet.
  • source – Źródło aktualizacji. Wspierane tylko przez Identi.ca. Twitter ignoruje ten parametr.
  • place_id – Twitter ID lokacji, która jest wymieniona w tweecie gdy użytkownik ma włączoną geolokację.
  • file – Plik, który zostanie użyty zamiast otwierania filename. filename jest nadal wymagany dla detekcji typu MIME oraz do używania pola formularzu w danych POST.
Typ zwracany:

obiekt Status
API.destroy_status(id)

Niszczy status określony przez parametr ID. Zuwierzytelniony użytkownik musi być autorem statusu by go zniszczyć.

Parametry:id – Numeryczne ID statusu.
Typ zwracany:obiekt Status
API.retweet(id)

Retweetuje tweet. Wymaga id tweeta, który retweetujesz.

Parametry:id – Numeryczne ID statusu.
Typ zwracany:obiekt Status
API.retweeters(id[, cursor][, stringify_ids])

Zwraca do maksymalnie 100 ID użytkowników, należących do użytkowników, którzy zretweetowali tweeta określonego przez paremetr ID.

Parametry:
  • id – Numeryczne ID statusu.
  • cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył.
  • stringify_ids – ID będą zwracane jago ciąg znaków.
Typ zwracany:

list of Integers
API.retweets(id[, count])

Zwraca do maksymalnie 100 pierwszych retweetów wybranego tweeta.

Parametry:
  • id – Numeryczne ID statusu.
  • count – Określa liczbę retweetów do pozyskania.
Typ zwracany:

lista obiektów Status
API.unretweet(id)

Odtweetowuje zretweetowany status. Wymaga id retweeta.

Parametry:id – Numeryczne ID statusu.
Typ zwracany:obiekt Status
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.

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.

Parametry:
  • 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.
Typ zwracany:

obiekt JSON

Metody użytkownika

API.get_user(id/user_id/screen_name)

Zwraca informacje o wybranym użytkowniku.

Parametry:
  • id – Określa ID lub nazwę wyświetlaną użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
Typ zwracany:

obiekt User
API.me()

Zwraca informacje o zuwierzytelnionym użytkowniku.

Typ zwracany:obiekt User
API.friends([id/user_id/screen_name][, cursor][, skip_status][, include_user_entities])

Returns a user’s friends ordered in which they were added 100 at a time. If no user is specified it defaults to the authenticated user.

Parametry:
  • id – Określa ID lub nazwę wyświetlaną użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył.
  • count – Liczba wyników do pobrania na stronę.
  • skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False.
  • include_user_entities – Gdy ustawione jako False to jednostki węzła obiektu user nie będą zawarte. Domyślnie True.
Typ zwracany:

lista obiektów User
API.followers([id/screen_name/user_id][, cursor])

Zwraca obserwujących użytkownika według chronologii rozpoczęcia przez nich obserwowania. Jeżeli użytkownik nie jest określony to domyślnie będzie użyty zuwierzytelniony użytkownik.

Parametry:
  • id – Określa ID lub nazwę wyświetlaną użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył.
  • count – Liczba wyników do pobrania na stronę.
  • skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False.
  • include_user_entities – Gdy ustawione jako False to jednostki węzła obiektu user nie będą zawarte. Domyślnie True.
Typ zwracany:

lista obiektów User
API.lookup_users([user_ids][, screen_names][, include_entities][, tweet_mode])

Zwraca fully-hydrated obiekt użytkownika, maksymalnie 100 użytkowników na jedno żądanie.

Należy mieć na uwadze kilka kwestii używając tej metody.

  • Musisz obserwować chronionego użytkownika by móc zobaczyć ich najnowszą zmianę statusu. Jeżeli nie obserwujesz go jego status zostanie usunięty.
  • Porządek ID użytkowników lub nazw wyświetlanych może nie być rownoważny z porządkiem użytkowników w zwróconym szyku.
  • Jeżeli żądany użytkownik jest nieznany, zablokowany lub usunięty to nie zostanie on zwrócony do listy wyników.
  • Jeżeli żadne z twoich wyszukiwań nie spełnia wymagań poprzez zwrócenie obiektu użytkownika, to wystąpi wtedy błąd HTTP 404.
Parametry:
  • user_ids – Lista ID użytkowników, masymalnie 100 może być zawartych w pojedyńczym żądaniu.
  • screen_names – Lista nazw wyświetlanych, masymalnie 100 może być zawartych w pojedyńczym żądaniu.
  • include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False.
  • tweet_mode – Poprawne wartości żądań są kompatybilne i rozszerzone, co nadaje im odpowiednio tryb kompatybilności lub trybowi rozszerzony, dla tweetów zawierających ponad 140 znaków.
Typ zwracany:

lista obiektów User
API.search_users(q[, count][, page])

Uruchom wyszukiwanie dla użytkowników podobne do przycisku Znajdź Ludzi na Twitter.com; używając teego API zostaną zwrócone te same rezultaty co w przypadku wyszukiwania ludzi. Używając tego API możliwe jest uzyskanie makymalnie 1000 pierwszych wyników.

Parametry:
  • q – Zapytanie, które jest uruchomione przeciwko wyszukiwaniom ludzi.
  • count – Określa liczbę statusów do uzyskania. Nie może być większe niz 20.
  • page – Określa którą stronę wyników otrzymać. Uwaga: istnieją limity stronnicowania.
Typ zwracany:

lista obiektów User

Metody wiadomości bezpośrednich

API.get_direct_message([id][, full_text])

Zwraca wybraną wiadomość bezpośrednią.

Parametry:
  • id – The id of the Direct Message event that should be returned.
  • full_text – Boolean wkazujący czy powinna być zwrócona całość tekstu wiadomości. Ustawione jako False powoduje, że wiadomość zostanie obcięta do 140 znaków. Domyślnie False.
Typ zwracany:

obiekt DirectMessage
API.list_direct_messages([count][, cursor])

Zwraca wszystkie zdarzenia Wiadomości Bezpośrednich (otrzymane i wysłane) w ostatnich 30 dniach. Posortowane w odwrotnym porządku chronologicznym.

Parametry:
  • count – Liczba wyników do pobrania na stronę.
  • cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył.
Typ zwracany:

lista obiektów DirectMessage
API.send_direct_message(recipient_id, text[, quick_reply_type][, attachment_type][, attachment_media_id])

Wysyła nową wiadomość bezpośrednią od zuwierzytelniongo użytkownika do wybranego użytkownika.

Parametry:
  • recipient_id – ID użytkownika, który ma otrzymać wiadomość.
  • text – Tekst twojej Wiadomości Bezpośrednij. Maksymalna długość: 10000 znaków.
  • quick_reply_type – Typ Szybkiej Odpowiedzi do pokazania użytkownikowi * options - szyk obiektów Opcji (maks 20). * text_input - tekst obiektu Input. * location - obiekt Lokacji.
  • attachment_type – Typ załącznika. Może być mediami lub lokacją.
  • attachment_media_id – ID mediów do powiązania z wiadomością. Wiadomość bezpośrednia może odnosić si tylko do pojedyńczeego media_id.
Typ zwracany:

obiekt DirectMessage
API.destroy_direct_message(id)

Usuwa wiadomość bezpośrednią określona w wymaganym parametrze ID. Zuwierzytelniony użytkownik musi być odbiorcą tej konkretnej wiadomości bezpośredniej. Wiadomości bezpośrednie mogą być usunięte tylko z intefejsu dostarczonego kontektu użytkownika. Inni członkowie konwersacji nadal mają dostęp do Wiadomości Bezpośrednich.

Parametry:id – ID Wiadomości Bezpośredniej która ma zostać usunięta.
Typ zwracany:None

Metody Znajomych

API.create_friendship(id/screen_name/user_id[, follow])

Stwórz nową znajomość z wybranym użytkownikiem (obserwuj).

Parametry:
  • id – Określa ID lub nazwę wyświetlaną użytkownika.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • follow – Włącz notyfikacje dla wybranego użytkownika wraz z dodaniem go do znajomych.
Typ zwracany:

obiekt User
API.destroy_friendship(id/screen_name/user_id)

Zerwij znajomość z wybranym użytkownikim (przestań obserwować).

Parametry:
  • id – Określa ID lub nazwę wyświetlaną użytkownika.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
Typ zwracany:

obiekt User
API.show_friendship(source_id/source_screen_name, target_id/target_screen_name)

Zwraca szczegółowe informacje na temat znajomości pomiędzy dwoma użytkownikami.

Parametry:
  • source_id – user_id podanego użytkownika.
  • source_screen_name – screen_name podanego użytkownika.
  • target_id – user_id wybranego użytkownika.
  • target_screen_name – screen_name wybranego użytkownika.
Typ zwracany:

obiekt Friendship
API.lookup_friendships(user_ids/screen_names)

Returns the relationships of the authenticated user to the list of up to 100 screen_names or user_ids provided.

Parametry:
  • user_ids – Lista ID użytkowników, masymalnie 100 może być zawartych w pojedyńczym żądaniu.
  • screen_names – Lista nazw wyświetlanych, masymalnie 100 może być zawartych w pojedyńczym żądaniu.
Typ zwracany:

Relationship object
API.friends_ids(id/screen_name/user_id[, cursor])

Zwraca szyk zawierający ID użytkowników obserwowanych przez wybranego użytkownika.

Parametry:
  • id – Określa ID lub nazwę wyświetlaną użytkownika.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył.
Typ zwracany:

list of Integers
API.followers_ids(id/screen_name/user_id)

Zwraca szyk zawierający ID użytkowników obserwujących wybranego użytkownika.

Parametry:
  • id – Określa ID lub nazwę wyświetlaną użytkownika.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył.
Typ zwracany:

list of Integers

Metody konta

API.verify_credentials([include_entities][, skip_status][, include_email])

Potwierdza, że dane podanego użytkownika są prawidłowe.

Parametry:
  • include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False.
  • skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False.
  • include_email – Gdy ustawione jako true, e-mail będzie zwrócony w obiekcie użytkownika jako ciąg znaków.
Typ zwracany:

obiekt User jeżeli dane są prawidłowe, w innym przypadku False
API.rate_limit_status()

Zwraca aktualne limity wartości dla metod należących do wybranej rodziny zasobów. Używając tego uwierzytelniania (tylko dla aplikacji), odpowiedź tej metody wskaże limit kontekstu dla tego uwierzytelniania.

Parametry:resources – Odseparowana przecinkami lista rodziny zasobów. Powinieneś znać aktualny limit wartośći dyspozycji dla.
Typ zwracany:obiekt JSON
API.update_profile_image(filename)

Aktualizuje zdjęcie profilowe zuwierzytelnionego użytkownika. Poprawne formaty: GIF, JPG oraz PNG

Parametry:filename – ścieżka lokalna dla obrazu, który ma być wrzucony. Nie jest to remote URL!
Typ zwracany:obiekt User
API.update_profile([name][, url][, location][, description])

Ustawia wartości, które użytkownicy mogą ustawić pod zakładką „Konto” w ustawieniach swojego konta.

Parametry:
  • name – Maksimum 20 znaków.
  • url – Maximum 100 znaków. Będzie poprzedzone „http://” jeżeli jeszcze nie jest.
  • location – Maximum 30 znaków.
  • description – Maximum 160 znaków.
Typ zwracany:

obiekt User

Ulubione metody

API.favorites([id][, page])

Zwraca ulubione statusy zuwierzytelnionego użytkownika lub użytkownika określonego przez parametr ID.

Parametry:
  • id – ID lub nazwa wyświetlana użytkownika od którego żądane sa ulubione
  • page – Określa którą stronę wyników otrzymać. Uwaga: istnieją limity stronnicowania.
Typ zwracany:

lista obiektów Status
API.create_favorite(id)

Ustawia jako ulubione statusy określone przez parametr ID jako zuwierzytelniony użytkownik.

Parametry:id – Numeryczne ID statusu.
Typ zwracany:obiekt Status
API.destroy_favorite(id)

Usuwa z ulubionych statusy określone przez parametr ID jako zuwierzytelniony użytkownik.

Parametry:id – Numeryczne ID statusu.
Typ zwracany:obiekt Status

Metody Blokowania

API.create_block(id/screen_name/user_id)

Blokuje użytkownika określonego przez parametr ID jako zuwierzytelniony użytkownik. Przerywa znajomość jeżeli taka istniała.

Parametry:
  • id – Określa ID lub nazwę wyświetlaną użytkownika.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
Typ zwracany:

obiekt User
API.destroy_block(id/screen_name/user_id)

Odblokowywuje użytkownika określonego przez parametr ID jako zuwierzytelniony użytkownik.

Parametry:
  • id – Określa ID lub nazwę wyświetlaną użytkownika.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
Typ zwracany:

obiekt User
API.blocks([page])

Zwraca szyk obiektów użytkownika, który blokowany jest przez zuwierzytelnionego użytkownika.

Parametry:page – Określa którą stronę wyników otrzymać. Uwaga: istnieją limity stronnicowania.
Typ zwracany:lista obiektów User
API.blocks_ids([cursor])

Zwraca szyk numerycznych ID użytkowników, którzy blokowani są przez zuwierzytelnionego użytkownika.

Parametry:cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył.
Typ zwracany:list of Integers

Metody Wyciszania

API.create_mute(id/screen_name/user_id)

Wycisza użytkownika określonego przez parametr ID dla zuwierzytelnionego użytkownika.

Parametry:
  • id – Określa ID lub nazwę wyświetlaną użytkownika.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
Typ zwracany:

obiekt User
API.destroy_mute(id/screen_name/user_id)

Wyłącza wyciszenie użytkownika określonego przez parametr ID dla zuwierzytelnionego użytkownika.

Parametry:
  • id – Określa ID lub nazwę wyświetlaną użytkownika.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
Typ zwracany:

obiekt User
API.mutes([cursor][, include_entities][, skip_status])

Zwraca szyk obiektów użytkownika, którego wyciszył zuwierzytelniony użytkownik.

Parametry:
  • cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył.
  • include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False.
  • skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False.
Typ zwracany:

lista obiektów User
API.mutes_ids([cursor])

Zwraca szyk numerycznych id użytkowników, których wyciszył zuwierzytelniony użytkownik.

Parametry:cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył.
Typ zwracany:list of Integers

Metody Reportowania Spamu

API.report_spam(id/screen_name/user_id[, perform_block])

Użytkownik określony przez ID zostaje zablokowany przez zuwierzytelniongo użytkownika oraz zgłoszony jako spammer.

Parametry:
  • id – Określa ID lub nazwę wyświetlaną użytkownika.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • perform_block – Boolean wskazujący czy zgłoszone konto ma być zablokowane. Domyślnie true.
Typ zwracany:

obiekt User

Metody Zapisanych wyszukań

API.saved_searches()

Zwraca zapisane zapytania zuwierzytelnionego użytkownika.

Typ zwracany:lista obiektów SavedSearch

Pobiera dane dla zapisanych wyszukiwań należących o zuwierzytelnionego użytkownika, określone przez podane ID.

Parametry:id – ID zapisanego wyszukania które ma zostać pobrane.
Typ zwracany:obiekt SavedSearch

Tworzy zapisane wyszukani dla zuwierzytelnionego użytkownika.

Parametry:query – Zapytanie dla wyszukania, które użytkownik chciałby zapisać.
Typ zwracany:obiekt SavedSearch

Niszczy zapisane wyszukianie dla zuwierzytelnionego użytkownika. Wyszukanie określone przez ID musi należeć do zuwierzytelnionego użytkownika.

Parametry:id – ID zapisanego wyszukania które ma zostać usunięte.
Typ zwracany:obiekt SavedSearch

Search Methods

API.search(q[, geocode][, lang][, locale][, result_type][, count][, until][, since_id][, max_id][, include_entities])

Zwraca zbiór odpowiednich tweetów pasujących do określonego zapytania.

Proszę miej na uwadze, że usługa wyszukiwania Twittera oraz Search API nie są w założeniu pełnym źródłem tweetów. Nie wszystkie tweety będą zindeksowane lub udostępnione przez wyszukiwarkę.

W API v1.1 format odpowiedzi dla Search API został udoskonalony tak by zwracał obiekty tweetów podobnie jak obiekty, które możesz znaleśść w REST API oraz platformie. Jednakże, atrybuty perspektywiczne (pola które odnoszą się do perspektywy zuwierzytelnionego użytkownika) nie są na tą chwilę wspierane w tym punkcie końcowym.[1][2]

Parametry:
  • q – ciąg znaków zapytania wyszukiwania dla maksimum 500 znaków, wliczając w to operatory. Zapytania mogą być także ograniczone przez ich zawiłość.
  • geocode – Zwraca tweety w oparciu o lokalizacje użytkownika wewnątrz promienia podanej szerokości/długości geograficznej. Lokacja domyślnie jest pobierana z Geotagging API, lecz zostanie cofnięta do profilu Twitter. Wartość parametru jest określona przez „szerokość,długość,promień” gdzie jednostki promienia muszą być określone jako „mi” (mile) lub „km” (kilometry). Uwaga: nie możesz użyć pobliskiego operatora poprzez API by zgeokodyfikować przypadkowe lokacje; jenakże możesz użyć tego parametru geocode do wyszukania geokodów bezpośrednio. Maksymalnie 1000 różnych „podregionów” będzie brane pod uwagę używajac modyfikatora promienia.
  • lang – Ogranicza tweey to podanego języka, nadanego przez kod ISO 639-1. Detekcja języka jest best-effort.
  • locale – Określa język zapytania, które będzie wysłane (na tę chwię tylko „ja”). Jesto skierowane do konsumentów posiadających szczególne wymagania językowe. Domyślnie działa w większości przypadków.
  • result_type – Określa jaki typ wyników wyszukiwania chciałbyś otrzymywać. Domyślnie „mixed”. Poprawne wartości zawierają: * mixed : zawiera wyniki popularne oraz w czasie rzeczywistym *recent : zwraca tylko najnowsze wyniki * popular : zwraca tylko popularne wyniki
  • count – Liczba wyników do pobrania na stronę.
  • until – Zwraca tweety stworzone przed określoną datą. Data powinna być w formacie YYYY-MM-DD. Miej na uwadze, że indeks wyszukiwania ma 7-dniowy limit. Innymi słowami, nie zostaną znalezione żadne tweety starsze niż tydzień.
  • since_id – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID. Liczba tweetów, które są dostępne w API jst limitowana. Jeżeli limit tweetów wydarzył się od since_id to since_id będzie najstarzym dostępnym ID.
  • max_id – Zwraca tylko statusy z ID mniejszym (tzn. starszym) lub równym określonemu ID.
  • include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False.
Typ zwracany:

obiekt SearchResults
API.search_30_day(environment_name, query[, tag][, fromDate][, toDate][, maxResults][, next])

Premium search that provides Tweets posted within the last 30 days.

Parametry:
  • environment_name – 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.
API.search_full_archive(environment_name, query[, tag][, fromDate][, toDate][, maxResults][, next])

Premium search that provides Tweets from as early as 2006, starting with the first Tweet posted in March 2006.

Parametry:
  • environment_name – 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.

Metoda Listy

API.create_list(name[, mode][, description])

Tworzy nową listę dla zuwierzytelnionego użytkownia. Miej na uwadzę, że możesz stworzyć maksymalnie 1000 list dla jednego konta.

Parametry:
  • name – Nazwa nowej listy.
  • mode – Czy lista jest publiczna czy prywatna. Wartości mogą być publiczne i prwyatne. Domyślnie listy są publiczne jeżeli nie jest ustawiony żaden tryb.
  • description – Opis listy, którą tworzysz.
Typ zwracany:

obiekt List
API.destroy_list([owner_screen_name/owner_id, ]list_id/slug)

Usuwa określoną listę. Zuwierzytelniony użytkownik musi być właścicielem listy by ją usunąć.

Parametry:
  • owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez żeton.
  • owner_id – ID użytkownika, który jest właścicielem listy żadanej przez żeton.
  • list_id – Numeryczna lista ID.
  • slug – Możesz zidentyfikować listę używając jej żetona zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name.
Typ zwracany:

obiekt List
API.update_list(list_id/slug[, name][, mode][, description][, owner_screen_name/owner_id])

Aktualizuje wybraną listę. Zuwierzytelniony użytkownik musi być właścicielem listy by ją zaktualizować.

Parametry:
  • list_id – Numeryczna lista ID.
  • slug – Możesz zidentyfikować listę używając jej żetona zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name.
  • name – Nazwa listy.
  • mode – Czy lista jest publiczna czy prywatna. Wartości mogą być publiczne i prwyatne. Domyślnie listy są publiczne jeżeli nie jest ustawiony żaden tryb.
  • description – Opis nadany liście.
  • owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez żeton.
  • owner_id – ID użytkownika, który jest właścicielem listy żadanej przez żeton.
Typ zwracany:

obiekt List
API.lists_all([screen_name][, user_id][, reverse])

Zwraca wszystkie listy, które subskrybuje zuwierzytelniony lub określony użytkownik, w tym ich własne. Użytkownik określony jest poprzez parametry user_id lub screen name. Jeżeli użytkownik nie jest podany to zostanie wtedy użyty zuwierzytelniony użytkownik.

Maksymalnie 100 wyników może być zwrócone przez to wywołanie. Listy subskrybowane są zwrócone jako pirwsze, tuż za nimi listy posiadane na własność. To oznacza, że jeżeli użytkownik subsrybuje 90 list i posiada 20 list to ta metoa zwróci 90 list subskrybowanych i 10 list posiadanych. Metoda reverse zwraca posiadane listy jako pierwsze, tak więc z ustawieniem reverse=true zwrócone będzie 20 list posiadanych i 80 subskrybowanych.

Parametry:
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • reverse – Boolean wskazujący czy chiałbyś by posiadane na własność listy zostały zwrócone jako pierwsze. Zobacz opis powyżej po więcej informacji na temat tego parametru.
Typ zwracany:

lista obiektów List
API.lists_memberships([screen_name][, user_id][, filter_to_owned_lists][, cursor][, count])

Zwraca listy, do których został dodany wybrany użytkownik. Jeżeli user_id lub screen_name nie są podane to zwracane jest członkostwo dla zuwierzytelnionego użytkownika.

Parametry:
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • filter_to_owned_lists – Boolean wskazujący czy zwrócić tylko listy, które posiada zuwierzytelniony użytkownik oraz użytkownik reprezentowany przez user_id lub screen_name.
  • cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył.
  • count – Liczba wyników do pobrania na stronę.
Typ zwracany:

lista obiektów List
API.lists_subscriptions([screen_name][, user_id][, cursor][, count])

Zdobywa kolekcję list do którye subskrybuje wybrany użytkownnik, domyślnie 20 list na jedną stronę. Nie zawiera list posiadanych przez użytkownika.

Parametry:
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył.
  • count – Liczba wyników do pobrania na stronę.
Typ zwracany:

lista obiektów List
API.list_timeline(list_id/slug[, owner_id/owner_screen_name][, since_id][, max_id][, count][, include_entities][, include_rts])

Zwraca oś czasu tweetów, których autorami są członkowie wybranej listy. Domyślnie zawiera retweety. Użyj parametru include_rts=false by pominąć retweety.

Parametry:
  • list_id – Numeryczna lista ID.
  • slug – Możesz zidentyfikować listę używając jej żetona zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name.
  • owner_id – ID użytkownika, który jest właścicielem listy żadanej przez żeton.
  • owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez żeton.
  • since_id – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID.
  • max_id – Zwraca tylko statusy z ID mniejszym (tzn. starszym) lub równym określonemu ID.
  • count – Liczba wyników do pobrania na stronę.
  • include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False.
  • include_rts – Boolean wskazujący czy oś czasu listy będzie zawierać natywne retweety (jeżeli istnieją) w dodatku do standardowego strumienia tweetów. Format wyjścia reteetowanych tweetów jest identyczny do tego widocznego w home_timeline.
Typ zwracany:

lista obiektów Status
API.get_list(list_id/slug[, owner_id/owner_screen_name])

Zwraca wybraną listę. Prywate listy będą pokazane tylko jeżeli zuwierzytelniony użytkownik jest ich właścicielem.

Parametry:
  • list_id – Numeryczna lista ID.
  • slug – Możesz zidentyfikować listę używając jej żetona zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name.
  • owner_id – ID użytkownika, który jest właścicielem listy żadanej przez żeton.
  • owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez żeton.
Typ zwracany:

obiekt List
API.add_list_member(list_id/slug, screen_name/user_id[, owner_id/owner_screen_name])

Dodaje nowego członka do listy. Zuwierzytelniony użytkownik musi być właścicielem listy by dodawać do niej członków. Lista może zawierać maksymalnie 5000 członków.

Parametry:
  • list_id – Numeryczna lista ID.
  • slug – Możesz zidentyfikować listę używając jej żetona zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • owner_id – ID użytkownika, który jest właścicielem listy żadanej przez żeton.
  • owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez żeton.
Typ zwracany:

obiekt List
API.add_list_members(list_id/slug, screen_name/user_id[, owner_id/owner_screen_name])

Dodaje członków do listy, maksymalnie 100. Zuwierzytelniony użytkownik musi być właścicielem listy by dodawać do niej członków. Lista może zawierać maksymalnie 5000 członków.

Parametry:
  • list_id – Numeryczna lista ID.
  • slug – Możesz zidentyfikować listę używając jej żetona zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name.
  • screen_name – Oddzielona przecinkami lista nazw, maksymalnie 100 na jedno żądanie.
  • user_id – Oddzielona przecinkami lista ID użytkowników, maksymalnie 100 na jedno żądanie.
  • owner_id – ID użytkownika, który jest właścicielem listy żadanej przez żeton.
  • owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez żeton.
Typ zwracany:

obiekt List
API.remove_list_member(list_id/slug, screen_name/user_id[, owner_id/owner_screen_name])

Usuwa wybranego użytkownika z listy. Zuwierzytelniony użytkownik musi być właścicielem listy by usuwać z niej użytkowników.

Parametry:
  • list_id – Numeryczna lista ID.
  • slug – Możesz zidentyfikować listę używając jej żetona zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • owner_id – ID użytkownika, który jest właścicielem listy żadanej przez żeton.
  • owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez żeton.
Typ zwracany:

obiekt List
API.remove_list_members(list_id/slug, screen_name/user_id[, owner_id/owner_screen_name])

Usuwa użytkowników z listy, maksymalnie 100. Zuwierzytelniony użytkownik musi być właścicielem listy by usuwać z niej użytkowników. Listy mogą zawierać maksymalnie 5000 użytkowników.

Parametry:
  • list_id – Numeryczna lista ID.
  • slug – Możesz zidentyfikować listę używając jej żetona zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name.
  • screen_name – Oddzielona przecinkami lista nazw, maksymalnie 100 na jedno żądanie.
  • user_id – Oddzielona przecinkami lista ID użytkowników, maksymalnie 100 na jedno żądanie.
  • owner_id – ID użytkownika, który jest właścicielem listy żadanej przez żeton.
  • owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez żeton.
Typ zwracany:

obiekt List
API.list_members(list_id/slug[, owner_id/owner_screen_name][, cursor])

Zwraca użytkowników z określonej listy.

Parametry:
  • list_id – Numeryczna lista ID.
  • slug – Możesz zidentyfikować listę używając jej żetona zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name.
  • owner_id – ID użytkownika, który jest właścicielem listy żadanej przez żeton.
  • owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez żeton.
  • cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył.
Typ zwracany:

lista obiektów User
API.show_list_member(list_id/slug, screen_name/user_id[, owner_id/owner_screen_name])

Sprawdza czy określony użytkownik jest członkiem określonej listy.

Parametry:
  • list_id – Numeryczna lista ID.
  • slug – Możesz zidentyfikować listę używając jej żetona zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • owner_id – ID użytkownika, który jest właścicielem listy żadanej przez żeton.
  • owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez żeton.
Typ zwracany:

obiekt User jeżeli użytkownik jest członkiem listy
API.subscribe_list(list_id/slug[, owner_id/owner_screen_name])

Subskrybuje zuwierzytelnionego użytkownika do określonej listy.

Parametry:
  • list_id – Numeryczna lista ID.
  • slug – Możesz zidentyfikować listę używając jej żetona zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name.
  • owner_id – ID użytkownika, który jest właścicielem listy żadanej przez żeton.
  • owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez żeton.
Typ zwracany:

obiekt List
API.unsubscribe_list(list_id/slug[, owner_id/owner_screen_name])

Anuluje subskrypcję zuwierzytelnionego użytkownika do określonej listy.

Parametry:
  • list_id – Numeryczna lista ID.
  • slug – Możesz zidentyfikować listę używając jej żetona zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name.
  • owner_id – ID użytkownika, który jest właścicielem listy żadanej przez żeton.
  • owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez żeton.
Typ zwracany:

obiekt List
API.list_subscribers(list_id/slug[, owner_id/owner_screen_name][, cursor][, count][, include_entities][, skip_status])

Zwraca subskrybentów wybranej listy. Subskrybenci prywatnych list będą wyświetleni tylko jeżeli zuwierzytelniony użytkownik jest właścicielem listy.

Parametry:
  • list_id – Numeryczna lista ID.
  • slug – Możesz zidentyfikować listę używając jej żetona zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name.
  • owner_id – ID użytkownika, który jest właścicielem listy żadanej przez żeton.
  • owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez żeton.
  • cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył.
  • count – Liczba wyników do pobrania na stronę.
  • include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False.
  • skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False.
Typ zwracany:

lista obiektów User
API.show_list_subscriber(list_id/slug, screen_name/user_id[, owner_id/owner_screen_name])

Sprawdza czy określony użytkownik jest subskrybentem określonej listy.

Parametry:
  • list_id – Numeryczna lista ID.
  • slug – Możesz zidentyfikować listę używając jej żetona zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name.
  • screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika.
  • owner_id – ID użytkownika, który jest właścicielem listy żadanej przez żeton.
  • owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez żeton.
Typ zwracany:

obiekt User jeżeli użytkownik subskrybuje listę

Metody Geo

API.reverse_geocode([lat][, long][, accuracy][, granularity][, max_results])

Posiadając szerokość i długość geograficzną, wyszukiwane będą miejsca (miasta i dzielnice), których ID mogą być określone w wywołaniu dla update_status() tak by wyglądały jako nazwa lokacji. To wywołanie dostarcza szczegółowe informacje na temat lokacji; funkcja nearby_places() powinna być używana do zdobywania list miejscw okolicy, bez szczegółowych informacji.

Parametry:
  • lat – Szerokość geograficzna lokacji.
  • long – Długość geograficzna lokacji.
  • accuracy – Określa „region” do wyszukiwania, między innymi numer (wtedy jest to zasięg w metrach, ale może być to też ciąg znaków zakończonych jako stopy). Jeżeli nie jest to przekazane, założony będzie zasięg 0m.
  • granularity – Assumed to be neighborhood by default; can also be city.
  • max_results – Wskazówka co do maksymalnej liczby rezultatów, które zostaną zwrócone. Jest to tylko wskazanie, nie musisz się do niego stosować.
API.geo_id(id)

Posiadając id lokacji podaje więcej informacji na jej temat.

Parametry:id – Poprawny ID Twittera lokacji.

Metody Użyteczności

API.configuration()

Zwraca aktualną konfigurację używaną przez Twitter, w tym żetony twitter.cm, które nie są nazwami użytkowników, maksymalne rozmiary zdjęcia oraz długość skróconego URL t.co. Zaleca się by aplikacje żądały tego punktu końcowego gdy są obłaowane, jednak nie więcej niż raz dziennie.

Metody Mediów

API.media_upload(filename[, file])

Użyj tego punktu końcowego by wrzucić obraz na Twitter.

Parametry:
  • filename – Nazwa pliku obrazu do wrzucenia. Jest automatycznie otwarte, chyba, że file jest określone.
  • file – Obiekt pliku, który musi być użyty zamiast otwierania filename. filename jest nadal wymagane dla detekcji typu MIME oraz do użytwania pól formy w danych POST.
Typ zwracany:

obiekt Media
API.create_media_metadata(media_id, alt_text)

Ten punkt końcowy może być użyty do dostarczenia dodatkowych informacji na temat wrzuconego media_id. Ta funkcja na tę chwilę jest wspierana tylko przez obrazy i GIFy. Wywołaj ten punkt końcowy by dodać dodatkowe metadane takie jak alt text.

Parametry:
  • media_id – ID mediów, do których dodany jest alt text.
  • alt_text – Alt tekst który zostanie dodany do obrazu.

tweepy.error — Wyjątki

Wyjątki są dostępne bezpośrednio w module tweepy co oznacza, że tweepy.error sam w sobie nie musi zostać zimportowany. Na przykład: tweepy.error.TweepError jest dostępny jako tweepy.TweepError.

exception TweepError

Główny wyjątek używany przez Tweepy. Pojawia się w różnych przypadkach.

Gdy podniesiony jest TweepError z powodu błedu, którym odpowiedział Twitter to kod błedu (tak jak jest to określone w dokumentacji API) może być znaleziony w TweepError.response.text.. Uwaga: TweepErrors może być także podniesiony wraz z innymi rzeczami jako wiadomość (na przykład jako prosty błąd ciągów znaków powodu).

exception RateLimitError

Jest podniesione gdy metoda API nie działa ze względu na osiągnięcie limitu współczynników określonej przez Twitter. Ułatwia to obsługę limitu współczynników.

Dziedziczy od TweepError więc except TweepError też złapie RateLimitError.

Przypisy

[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