Dokumentacja API
Klient WykopApi v3
- class wykop_sdk_reloaded.v3.client.WykopApiClient(auth)[źródło]
Główna klasa klienta, zbiór mixinów.
- Parametry:
auth (AuthClient)
- class wykop_sdk_reloaded.v3.client._WykopApiClientArticleMixin(auth)[źródło]
Mixin zawierający akcje na artykułach.
- Parametry:
auth (AuthClient)
- articles_get_article(article_id)[źródło]
Pobranie informacji o artykule
- Parametry:
article_id (str)
- Typ zwracany:
dict
- articles_list_articles_by_tag(tag, sort=StreamSortType.ALL, page=None, limit=None, year=None, month=None)[źródło]
Zwraca pełną liste artykułów konkretnego tagu UWAGA: Parametr page przyjmuje dla użytkowników niezalogowanych int z numerem strony, a dla zalogowanych hash strony. UWAGA2: Standardowa paginacja jest dostępna tylko dla użytkowników niezalogowanych. Paginacja dla użytkowników zalogowanych będzie zwracać hash next dla następnej strony i prev dla poprzedniej.
- Parametry:
tag (str)
sort (StreamSortType)
page (str | None)
limit (int | None)
year (int | None)
month (int | None)
- Typ zwracany:
dict
- class wykop_sdk_reloaded.v3.client._WykopApiClientEntriesMixin(auth)[źródło]
Mixin zawierający akcje na wpisach.
- Parametry:
auth (AuthClient)
- entries_create_entry(content=None, photo=None, embed=None, adult=None)[źródło]
Wymaga zalogowania uzytkownika.
Dodawanie nowego wpisu na mikroblogu
- Parametry:
content (str | None)
photo (str | None)
embed (str | None)
adult (bool | None)
- Typ zwracany:
dict | None
- entries_delete_entry(entry_id)[źródło]
Wymaga zalogowania uzytkownika.
Usuwanie wpisu z mikrobloga
- Parametry:
entry_id (str)
- Typ zwracany:
dict | None
- entries_get_entry(entry_id)[źródło]
Pobranie wpisu z mikrobloga
- Parametry:
entry_id (str)
- Typ zwracany:
dict
- entries_list_entries(sort=EntriesSortType.HOT, last_update=EntriesLastUpdateType.TWELVE, page=None, limit=None)[źródło]
Zwraca wpisy z mikrobloga. UWAGA: Parametr page przyjmuje dla użytkowników niezalogowanych int z numerem strony, a dla zalogowanych hash strony. UWAGA2: Standardowa paginacja jest dostępna tylko dla użytkowników niezalogowanych. Paginacja dla użytkowników zalogowanych będzie zwracać hash next dla następnej strony i prev dla poprzedniej.
- Parametry:
sort (EntriesSortType)
last_update (EntriesLastUpdateType)
page (str | None)
limit (int | None)
- Typ zwracany:
dict
- entries_list_entries_by_tag(tag, sort=StreamSortType.ALL, page=None, limit=None, year=None, month=None)[źródło]
Zwraca pełną liste wpisów konkretnego tagu UWAGA: Parametr page przyjmuje dla użytkowników niezalogowanych int z numerem strony, a dla zalogowanych hash strony. UWAGA2: Standardowa paginacja jest dostępna tylko dla użytkowników niezalogowanych. Paginacja dla użytkowników zalogowanych będzie zwracać hash next dla następnej strony i prev dla poprzedniej.
- Parametry:
tag (str)
sort (StreamSortType)
page (str | None)
limit (int | None)
year (int | None)
month (int | None)
- Typ zwracany:
dict
- entries_list_voters(entry_id, page=1)[źródło]
Pobiera nazwy użytkowników którzy głosowali na wpis z mikrobloga. Wynik jest paginowany.
- Parametry:
entry_id (str)
page (int)
- Typ zwracany:
dict
- entries_update_entry(entry_id, content=None, photo=None, embed=None, adult=None)[źródło]
Wymaga zalogowania uzytkownika.
Edycja wpisu z mikrobloga
- Parametry:
entry_id (str)
content (str | None)
photo (str | None)
embed (str | None)
adult (bool | None)
- Typ zwracany:
dict | None
- class wykop_sdk_reloaded.v3.client._WykopApiClientEntryCommentsMixin(auth)[źródło]
Mixin zawierający akcje na komentarzach do wpisów.
- Parametry:
auth (AuthClient)
- entry_comments_create_comment(entry_id, content=None, photo=None, embed=None, adult=None)[źródło]
Wymaga zalogowania uzytkownika.
Dodawanie nowego komentarza do wpisu na mikroblogu
- Parametry:
entry_id (str)
content (str | None)
photo (str | None)
embed (str | None)
adult (bool | None)
- Typ zwracany:
dict | None
- entry_comments_delete_comment(entry_id, comment_id)[źródło]
Wymaga zalogowania uzytkownika.
Usuwanie komentarza do wpisu z mikrobloga
- Parametry:
entry_id (str)
comment_id (str)
- Typ zwracany:
dict | None
- entry_comments_list_comments(entry_id, page=None, limit=None)[źródło]
Komentarze do wpisu z mikrobloga
- Parametry:
entry_id (str)
page (str | None)
limit (int | None)
- Typ zwracany:
dict
- entry_comments_update_comment(entry_id, comment_id, content=None, photo=None, embed=None, adult=None)[źródło]
Wymaga zalogowania uzytkownika.
Edycja komentarza do wpisu na mikroblogu
- Parametry:
entry_id (str)
comment_id (str)
content (str | None)
photo (str | None)
embed (str | None)
adult (bool | None)
- Typ zwracany:
dict | None
- class wykop_sdk_reloaded.v3.client._WykopApiClientLinkCommentsMixin(auth)[źródło]
Mixin zawierający akcje na komentarzach do znalezisk.
- Parametry:
auth (AuthClient)
- link_comments_create_comment(link_id, content=None, photo=None, embed=None, adult=None)[źródło]
Wymaga zalogowania uzytkownika.
Dodawanie nowego komentarza do wykopaliska
- Parametry:
link_id (str)
content (str | None)
photo (str | None)
embed (str | None)
adult (bool | None)
- Typ zwracany:
dict | None
- link_comments_create_comment_to_comment(link_id, comment_id, content=None, photo=None, embed=None, adult=None)[źródło]
Wymaga zalogowania uzytkownika.
Dodawanie nowego podkomentarza do istniejącego komentarza
- Parametry:
link_id (str)
comment_id (str)
content (str | None)
photo (str | None)
embed (str | None)
adult (bool | None)
- Typ zwracany:
dict | None
- link_comments_delete_comment(link_id, comment_id)[źródło]
Wymaga zalogowania uzytkownika.
Usuwanie komentarza do wykopaliska
- Parametry:
link_id (str)
comment_id (str)
- link_comments_list_comments(link_id, sort=LinkCommentSortType.NEWEST, page=None, limit=None)[źródło]
Komentarze do znaleziska
- Parametry:
link_id (str)
sort (LinkCommentSortType)
page (str | None)
limit (int | None)
- Typ zwracany:
dict
- link_comments_update_comment(link_id, comment_id, content=None, photo=None, embed=None, adult=None)[źródło]
Wymaga zalogowania uzytkownika.
Edycja komentarza do wykopaliska
- Parametry:
link_id (str)
comment_id (str)
content (str | None)
photo (str | None)
embed (str | None)
adult (bool | None)
- Typ zwracany:
dict | None
- link_comments_vote_comment(link_id, comment_id, type)[źródło]
Wymaga zalogowania uzytkownika.
Glosowanie na komentarz do wykopaliska
- Parametry:
link_id (str)
comment_id (str)
type (LinkCommentVoteType)
- class wykop_sdk_reloaded.v3.client._WykopApiClientLinkDraftMixin(auth)[źródło]
Mixin zawierający akcje do zarządzania stworzonymi znaleziskami (linkami).
- Parametry:
auth (AuthClient)
- links_draft_create_draft_step_one(url)[źródło]
Wymaga zalogowania uzytkownika.
Dodawanie nowego linku w wersji roboczej krok pierwszy
- Parametry:
url (str)
- links_draft_create_draft_step_two(key, title, description, tags, adult, photo=None)[źródło]
Wymaga zalogowania uzytkownika.
Dodawanie nowego linku w wersji roboczej krok drugi - publikacja.
params photo: Załącznik użytkownika. W celu dodania należy podać „key” pliku z media/photo. Akceptowane są tylko pliki przesłane jako typ links. params tags: Tagi. Można wysłać do 6 tagów (bez «#»).
- Parametry:
key (str)
title (str)
description (str)
tags (list[str])
adult (bool)
photo (str | None)
- links_draft_delete_draft(key)[źródło]
Wymaga zalogowania uzytkownika.
Usuwa wersję robocza linku
- Parametry:
key (str)
- links_draft_get_draft(key)[źródło]
Wymaga zalogowania uzytkownika.
Zwraca wersję robocza linku
- Parametry:
key (str)
- links_draft_list_drafts()[źródło]
Wymaga zalogowania uzytkownika.
Lista wersji roboczych linków zalogowanego użytkownika Wersje robocze są kasowane po upływie 24h.
- links_draft_update_draft(key, title=None, description=None, tags=None, adult=None, photo=None)[źródło]
Wymaga zalogowania uzytkownika.
Aktualizacja linku w wersji roboczej
params photo: Załącznik użytkownika. W celu dodania należy podać „key” pliku z media/photo. Akceptowane są tylko pliki przesłane jako typ links. params tags: Tagi. Można wysłać do 6 tagów (bez «#»).
- Parametry:
key (str)
title (str | None)
description (str | None)
tags (list[str] | None)
adult (bool | None)
photo (str | None)
- class wykop_sdk_reloaded.v3.client._WykopApiClientLinksMixin(auth)[źródło]
Mixin zawierający akcje na znaleziskach (linkach).
- Parametry:
auth (AuthClient)
- links_delete_link(link_id)[źródło]
Wymagana zalogowania uzytkownika
Usuwanie znaleziska
- Parametry:
link_id (str)
- links_get_link(link_id)[źródło]
Wymagana zalogowania uzytkownika
Szczególy znaleziska
- Parametry:
link_id (str)
- links_list_links(type, page=None, limit=None)[źródło]
Zwraca listę znalezisk UWAGA: Parametr page przyjmuje dla użytkowników niezalogowanych int z numerem strony, a dla zalogowanych hash strony. UWAGA2: Standardowa paginacja jest dostępna tylko dla użytkowników niezalogowanych. Paginacja dla użytkowników zalogowanych będzie zwracać hash next dla następnej strony i prev dla poprzedniej. UWAGA3: Dla parametru type=upcoming (wykopalisko) paginacja przyjmuje parametr page jako int z nr strony, zarówno dla użytkowników zalogowanych i niezalogowanych
- Parametry:
type (LinkType)
page (str | None)
limit (int | None)
- Typ zwracany:
dict
- links_update_link(link_id, title, description, tags, adult, photo=None)[źródło]
Wymaga zalogowania uzytkownika.
Można modyfikować tylko własne znaleziska. Autor może modyfikować wpis 15 minut od daty dodania. Link nie możne się znajdować na stronie głwnej. UWAGA: Gdy znalezisko ma ustalone zdjęcie, a w edycji atrybut „photo” nie zostanie przesłany lub będzie przesłany jako null - zdjęcie zostanie usunięte.
params photo: Załącznik użytkownika. W celu dodania należy podać „key” pliku z media/photo. Akceptowane są tylko pliki przesłane jako typ links. params tags: Tagi. Można wysłać do 6 tagów (bez «#»).
- Parametry:
link_id (str)
title (str)
description (str)
tags (list[str])
adult (bool)
photo (str | None)
- links_vote_down_link(link_id, reason)[źródło]
Wymaga zalogowania uzytkownika
Zakopanie znaleziska
- Parametry:
link_id (str)
reason (LinkVoteDownReason)
- class wykop_sdk_reloaded.v3.client._WykopApiClientMediaEmedMixin(auth)[źródło]
Mixin zawierający akcje na zewnętrznych linkach.
- Parametry:
auth (AuthClient)
- class wykop_sdk_reloaded.v3.client._WykopApiClientMediaPhotosMixin(auth)[źródło]
Mixin zawierający akcje na zdjęciach/obrazkach.
- Parametry:
auth (AuthClient)
- photos_delete_photo(key)[źródło]
Wymaga zalogowania uzytkownika.
Właściciel pliku posiada możliwość jego usunięcia z serwera.
- Parametry:
key (str)
- Typ zwracany:
dict | None
- photos_upload_file(picf, type)[źródło]
Wymaga zalogowania uzytkownika.
Wgrywanie wskazanego pliku przez URL na serwer Dozwolone jest wgrywanie multimedialnych plików o następujących mimetype: «image/jpeg», «image/jpg», «image/pjpeg», «image/gif», «image/png», «image/x-png». Maksymalny rozmiar pliku to 10 MB.
- Parametry:
picf (str)
type (MediaPhotosType)
- Typ zwracany:
dict | None
- photos_upload_url(url, type)[źródło]
Wymaga zalogowania uzytkownika.
Wgrywanie wskazanego pliku przez URL na serwer Dozwolone jest wgrywanie multimedialnych plików o następujących mimetype: «image/jpeg», «image/jpg», «image/pjpeg», «image/gif», «image/png», «image/x-png». Maksymalny rozmiar pliku to 10 MB.
- Parametry:
url (str)
type (MediaPhotosType)
- Typ zwracany:
dict | None
- class wykop_sdk_reloaded.v3.client._WykopApiClientNotificationsMixin(auth)[źródło]
Mixin zawierający akcje na powiedomieniach.
- Parametry:
auth (AuthClient)
- notifinations_delete_all_entries()[źródło]
Wymaga zalogowania uzytkownika.
Usunięcie wszystkich powiadomień użytkownika
- notifinations_delete_all_pms()[źródło]
Wymaga zalogowania uzytkownika.
Usunięcie wszystkich powiadomień z prywatnych wiadomości
- notifinations_delete_entry(entry_id)[źródło]
Wymaga zalogowania uzytkownika.
Usunięcie powiadomienia
- Parametry:
entry_id (str)
- notifinations_delete_pm(pm_id)[źródło]
Wymaga zalogowania uzytkownika.
Usunięcie pw
- Parametry:
pm_id (str)
- notifinations_get_entry(entry_id)[źródło]
Wymaga zalogowania uzytkownika.
Pobranie jednej notyfikacji dla zalogowanego użytkownika
- Parametry:
entry_id (str)
- Typ zwracany:
dict
- notifinations_get_pm(pm_id)[źródło]
Wymaga zalogowania uzytkownika.
Pobranie pw dla zalogowanego użytkownika
- Parametry:
pm_id (str)
- Typ zwracany:
dict
- notifinations_list_entries()[źródło]
Wymaga zalogowania uzytkownika.
Pobranie notyfikacji
- Typ zwracany:
dict
- notifinations_list_pms()[źródło]
Wymaga zalogowania uzytkownika.
Pobranie listy notyfikacji o prywatnych wiadomościach użytkownika
- Typ zwracany:
dict
- notifinations_mark_all_entries_readed()[źródło]
Wymaga zalogowania uzytkownika.
Oznaczenie powiadomień użytkownika jako przeczytane
- notifinations_mark_all_pms_readed()[źródło]
Wymaga zalogowania uzytkownika.
Ustawienie wszystkich powiadomień z prywatnych wiadomości jako przeczytane
- notifinations_mark_entry_readed(entry_id)[źródło]
Wymaga zalogowania uzytkownika.
Ustawienie powiadomienia jako przeczytane
- Parametry:
entry_id (str)
- class wykop_sdk_reloaded.v3.client._WykopApiClientPMMixin(auth)[źródło]
Mixin zawierający akcje na prywatnych wiadomościach.
- Parametry:
auth (AuthClient)
- pms_create_pm(username, content, photo=None, embed=None)[źródło]
Dodawanie nowej wiadomości
Wymaga zalogowania uzytkownika.
- Parametry:
username (str)
content (str)
photo (str | None)
embed (str | None)
- pms_delete_conversation(username)[źródło]
Usuwa konwersację. Znika tylko po stronie osoby wykonującej akcję.
Wymaga zalogowania uzytkownika.
- Parametry:
username (str)
- pms_get_conversation(username, prev_message=None, next_message=None)[źródło]
Lista wiadomości z użytkownikiem
params prev_message: identyfikator (key) najstarszej widocznej wiadomości. Po jego podaniu zostaną doczytane starsze wiadomości. params next_message: identyfikator (key) najnowszej widocznej wiadomości. Po jego podaniu zostaną doczytane nowsze wiadomości.
Wymaga zalogowania uzytkownika.
- Parametry:
username (str)
prev_message (str | None)
next_message (str | None)
- class wykop_sdk_reloaded.v3.client._WykopApiClientProfileMixin(auth)[źródło]
Mixin zawierający akcje na profilu użytkownika.
- Parametry:
auth (AuthClient)
- profiles_get_my_profile()[źródło]
Pobranie danych publicznych i prywatnych zalogowanego użytkownika.
- Typ zwracany:
dict
- profiles_get_my_profile_short()[źródło]
Pobranie danych publicznych zalogowanego użytkownika - wersja skrócona.
- Typ zwracany:
dict
- profiles_get_profile(username)[źródło]
Pobranie danych publicznych danego użytkownika.
- Parametry:
username (str)
- Typ zwracany:
dict
- profiles_get_profile_actions(username)[źródło]
Lista akcji (wpisy i znaleziska) autorstwa danego użytkownika
- Parametry:
username (str)
- Typ zwracany:
dict
- profiles_get_profile_badges(username)[źródło]
Pobiera listę osiągnięć użytkownika
- Parametry:
username (str)
- Typ zwracany:
dict
- profiles_get_profile_entries_added(username, page=None, limit=None)[źródło]
Lista wpisów autorstwa danego użytkownika
- Parametry:
username (str)
page (str | None)
limit (int | None)
- Typ zwracany:
dict
- profiles_get_profile_entries_commented(username, page=None, limit=None)[źródło]
Lista komentarzy autorstwa danego użytkownika wraz z wpisem
- Parametry:
username (str)
page (str | None)
limit (int | None)
- Typ zwracany:
dict
- profiles_get_profile_entries_voted(username, page=None, limit=None)[źródło]
Lista plusowanych wpisów przez użytkownika
- Parametry:
username (str)
page (str | None)
limit (int | None)
- Typ zwracany:
dict
- profiles_get_profile_links_added(username, page=None, limit=None)[źródło]
Lista znalezisk autorstwa danego użytkownika
- Parametry:
username (str)
page (str | None)
limit (int | None)
- Typ zwracany:
dict
- profiles_get_profile_links_commented(username, page=None, limit=None)[źródło]
Lista komentarzy autorstwa danego użytkownika wraz ze znaleziskiem
- Parametry:
username (str)
page (str | None)
limit (int | None)
- Typ zwracany:
dict
- profiles_get_profile_links_down(username, page=None, limit=None)[źródło]
Lista znalezisk zakopanych przez zalogowanego użytkownika
- Parametry:
username (str)
page (str | None)
limit (int | None)
- Typ zwracany:
dict
- profiles_get_profile_links_published(username, page=None, limit=None)[źródło]
Lista znalezisk autorstwa danego użytkownika, które trafiły na stronę główną
- Parametry:
username (str)
page (str | None)
limit (int | None)
- Typ zwracany:
dict
Lista linków powiązanych autorstwa danego użytkownika wraz ze znaleziskiem
- Parametry:
username (str)
page (str | None)
limit (int | None)
- Typ zwracany:
dict
- profiles_get_profile_links_up(username, page=None, limit=None)[źródło]
Lista znalezisk wykopanych przez danego użytkownika
- Parametry:
username (str)
page (str | None)
limit (int | None)
- Typ zwracany:
dict
- profiles_get_profile_observed_tags(username)[źródło]
Pobranie obserwowanych tagów użytkownika
- Parametry:
username (str)
- Typ zwracany:
dict
- profiles_get_profile_short(username)[źródło]
Pobranie danych publicznych danego użytkownika - wersja skrócona.
- Parametry:
username (str)
- Typ zwracany:
dict
- profiles_get_profile_tags(username)[źródło]
Lista tagów autorskich użytkownika
- Parametry:
username (str)
- Typ zwracany:
dict
- class wykop_sdk_reloaded.v3.client._WykopApiClientTagsMixin(auth)[źródło]
Mixin zawierający akcje na tagach.
- Parametry:
auth (AuthClient)
- tags_edit_tag(tag, photo, description)[źródło]
Wymaga zalogowania uzytkownika.
Właściciel tagu może modyfikować tło (base64 str) oraz opis tagu.
- Parametry:
tag (str)
photo (str)
description (str)
- Typ zwracany:
dict | None
- tags_get_popular_user_tags()[źródło]
Kolekcja popularnych tagów autorskich (max do 10 wyników)
- Typ zwracany:
dict
Kolekcja powiązanych tagów (max do 10 wyników)
- Parametry:
tag (str)
- Typ zwracany:
dict
- tags_get_stream_of_tag(tag, sort=StreamSortType.ALL, page=None, limit=None, year=None, month=None)[źródło]
Zwraca pełną liste wpisów i znalezisk z konkretnego tagu UWAGA: Parametr page przyjmuje dla użytkowników niezalogowanych int z numerem strony, a dla zalogowanych hash strony. UWAGA2: Standardowa paginacja jest dostępna tylko dla użytkowników niezalogowanych. Paginacja dla użytkowników zalogowanych będzie zwracać hash next dla następnej strony i prev dla poprzedniej.
- Parametry:
tag (str)
sort (StreamSortType)
page (str | None)
limit (int | None)
year (int | None)
month (int | None)
- Typ zwracany:
dict
Bazowe klasy wyjątków
- exception wykop_sdk_reloaded.exceptions.WykopApiAuthorizationError[źródło]
HTTP 403 Brak autoryzacji - token niepoprawny albo wygasł i należy go odświeżyć
- exception wykop_sdk_reloaded.exceptions.WykopApiBlockedError[źródło]
HTTP 401 Endpoint został zablokowany
Typy
- class wykop_sdk_reloaded.v3.types.EntriesLastUpdateType(*values)[źródło]
(Działa tylko dla gorących wpisów) Określony przedział czasowy dla gorących wpisów
- ONE = 1
- SIX = 6
- THREE = 3
- TWELVE = 12
- TWENTY_FOUR = 24
- TWO = 2
- class wykop_sdk_reloaded.v3.types.EntriesSortType(*values)[źródło]
Sposób sortowania wpisów
- ACTIVE = 'active'
- HOT = 'hot'
- NEWEST = 'newest'
- class wykop_sdk_reloaded.v3.types.LinkCommentSortType(*values)[źródło]
Sposoby sortowania komentarzy pod znaleziskiem
- BEST = 'best'
- NEWEST = 'newest'
- OLDEST = 'oldest'
- class wykop_sdk_reloaded.v3.types.LinkCommentVoteType(*values)[źródło]
Typ oceny komentarza pod znaleziskiem
- DOWN = 'down'
- UP = 'up'
- class wykop_sdk_reloaded.v3.types.LinkType(*values)[źródło]
Typ znaliska (strona główna bądź wykopalisko)
- HOMEPAGE = 'homepage'
- UPCOMING = 'upcoming'
- class wykop_sdk_reloaded.v3.types.LinkVoteDownReason(*values)[źródło]
Powód zakopania znaleziska
- DUPLICATE = 1
- INAPPROPRIATE = 4
- SPAM = 2
- UNSUITABLE = 5
- UNTRUE = 3
- class wykop_sdk_reloaded.v3.types.MediaPhotosType(*values)[źródło]
Przeznaczenie wysłanego zdjęcia
- COMMENTS = 'comments'
- LINKS = 'links'
- SETTINGS = 'settings'