Sous-modules
- Module xdk.users.client
UsersClientUsersClient.__init__()UsersClient.block_dms()UsersClient.create_bookmark()UsersClient.delete_bookmark()UsersClient.follow_list()UsersClient.follow_user()UsersClient.get_blocking()UsersClient.get_bookmark_folders()UsersClient.get_bookmarks()UsersClient.get_bookmarks_by_folder_id()UsersClient.get_by_id()UsersClient.get_by_ids()UsersClient.get_by_username()UsersClient.get_by_usernames()UsersClient.get_followed_lists()UsersClient.get_followers()UsersClient.get_following()UsersClient.get_liked_posts()UsersClient.get_list_memberships()UsersClient.get_me()UsersClient.get_mentions()UsersClient.get_muting()UsersClient.get_owned_lists()UsersClient.get_pinned_lists()UsersClient.get_posts()UsersClient.get_reposts_of_me()UsersClient.get_timeline()UsersClient.like_post()UsersClient.mute_user()UsersClient.pin_list()UsersClient.repost_post()UsersClient.search()UsersClient.unblock_dms()UsersClient.unfollow_list()UsersClient.unfollow_user()UsersClient.unlike_post()UsersClient.unmute_user()UsersClient.unpin_list()UsersClient.unrepost_post()
- Module xdk.users.models
BlockDmsResponseCreateBookmarkRequestCreateBookmarkResponseDeleteBookmarkResponseFollowListRequestFollowListResponseFollowUserRequestFollowUserResponseGetBlockingResponseGetBookmarkFoldersResponseGetBookmarksByFolderIdResponseGetBookmarksResponseGetByIdResponseGetByIdsResponseGetByUsernameResponseGetByUsernamesResponseGetFollowedListsResponseGetFollowersResponseGetFollowingResponseGetLikedPostsResponseGetListMembershipsResponseGetMeResponseGetMentionsResponseGetMutingResponseGetOwnedListsResponseGetPinnedListsResponseGetPostsResponseGetRepostsOfMeResponseGetTimelineResponseLikePostRequestLikePostResponseMuteUserRequestMuteUserResponsePinListRequestPinListResponseRepostPostRequestRepostPostResponseSearchResponseUnblockDmsResponseUnfollowListResponseUnfollowUserResponseUnlikePostResponseUnmuteUserResponseUnpinListResponseUnrepostPostResponse
Contenu du module
users de X API
et sert de point d’entrée principal pour l’ensemble des fonctionnalités relatives aux utilisateurs.
class xdk.users.UsersClient
Paramètres
__init__
Paramètres
block_dms
Paramètres
L’identifiant de l’utilisateur cible dont l’utilisateur authentifié demande le blocage des DM.
Renvoie
BlockDmsResponse - Données de réponse
create_bookmark
Paramètres
L’identifiant de l’utilisateur source authentifié pour lequel ajouter des signets.
Corps de la requête
delete_bookmark
Paramètres
L’identifiant de l’utilisateur source authentifié dont le signet doit être supprimé.
L’identifiant de la Publication que l’utilisateur source souhaite supprimer de ses signets.
Retourne
DeleteBookmarkResponse - Données de la réponse
follow_list
Paramètres
L’identifiant de l’Utilisateur source authentifié qui suivra la Liste.
Corps de la requête
follow_user
Paramètres
L’identifiant de l’utilisateur source authentifié qui souhaite suivre l’utilisateur cible.
Corps de la requête
get_blocking
Paramètres
L’ID de l’utilisateur source authentifié dont il faut renvoyer les résultats.
Le nombre maximal de résultats.
Ce paramètre est utilisé pour obtenir une « page » spécifique de résultats.
Liste de champs d’utilisateur à afficher, séparés par des virgules.
Liste de champs à étendre, séparés par des virgules.
Liste de champs de Tweet à afficher, séparés par des virgules.
Renvoie
IteratorGetBlockingResponse
get_bookmark_folders
Paramètres
L’id de l’utilisateur source authentifié dont renvoyer les résultats.
Le nombre maximal de résultats.
Ce paramètre permet d’obtenir la « page » suivante de résultats.
Renvoie
IteratorGetBookmarkFoldersResponse
get_bookmarks
Paramètres
L’identifiant de l’utilisateur source authentifié pour lequel renvoyer les résultats.
Le nombre maximal de résultats.
Ce paramètre est utilisé pour obtenir la prochaine « page » de résultats.
Une liste de champs de Tweet, séparés par des virgules, à afficher.
Une liste de champs à étendre, séparés par des virgules.
Une liste de champs média, séparés par des virgules, à afficher.
Une liste de champs de sondage, séparés par des virgules, à afficher.
Une liste de champs d’utilisateur, séparés par des virgules, à afficher.
Une liste de champs de lieu, séparés par des virgules, à afficher.
Renvoie
IteratorGetBookmarksResponse
get_bookmarks_by_folder_id
Paramètres
L’identifiant de l’Utilisateur source authentifié pour lequel les résultats doivent être renvoyés.
L’identifiant du dossier de signets dont l’Utilisateur authentifié tente de récupérer des Publications.
Renvoie
GetBookmarksByFolderIdResponse - Données de la réponse
get_by_id
Paramètres
L’identifiant de l’Utilisateur à récupérer.
Une liste de champs d’Utilisateur, séparés par des virgules, à afficher.
Une liste de champs, séparés par des virgules, à étendre.
Une liste de champs de Tweet, séparés par des virgules, à afficher.
Valeur de retour
GetByIdResponse - Données de réponse
get_by_ids
Paramètres
Une liste d’ID d’utilisateur séparés par des virgules. Vous pouvez spécifier jusqu’à 100 ID.
Une liste de champs d’utilisateur séparés par des virgules à afficher.
Une liste de champs séparés par des virgules à étendre.
Une liste de champs de Tweet séparés par des virgules à afficher.
Valeur de retour
GetByIdsResponse - Données de réponse
get_by_username
Paramètres
Un nom d’utilisateur.
Une liste de champs utilisateur à afficher, séparés par des virgules.
Une liste de champs à étendre, séparés par des virgules.
Une liste de champs de Tweet à afficher, séparés par des virgules.
Renvoie
GetByUsernameResponse - Données de la réponse
get_by_usernames
Paramètres
Une liste de noms d’utilisateur séparés par des virgules.
Une liste de champs User séparés par des virgules à afficher.
Une liste de champs à étendre séparés par des virgules.
Une liste de champs Tweet séparés par des virgules à afficher.
Renvoie
GetByUsernamesResponse - Données de la réponse
get_followed_lists
Paramètres
L’ID de l’utilisateur à rechercher.
Le nombre maximal de résultats.
Ce paramètre permet d’obtenir une « page » spécifique de résultats.
Une liste de champs de Liste, séparés par des virgules, à afficher.
Une liste de champs, séparés par des virgules, à étendre.
Une liste de champs d’utilisateur, séparés par des virgules, à afficher.
Renvoie
IteratorGetFollowedListsResponse
get_followers
Paramètres
L’ID de l’utilisateur à interroger.
Le nombre maximal de résultats.
Ce paramètre est utilisé pour obtenir une « page » donnée de résultats.
Une liste, séparée par des virgules, de champs d’utilisateur à afficher.
Une liste, séparée par des virgules, de champs à étendre.
Une liste, séparée par des virgules, de champs de Tweet à afficher.
Renvoie
IteratorGetFollowersResponse
get_following
Paramètres
L’ID de l’utilisateur à rechercher.
Le nombre maximal de résultats.
Ce paramètre est utilisé pour récupérer une « page » spécifique de résultats.
Une liste, séparée par des virgules, de champs utilisateur à afficher.
Une liste, séparée par des virgules, de champs à développer.
Une liste, séparée par des virgules, de champs de Tweet à afficher.
Renvoie
IteratorGetFollowingResponse
get_liked_posts
Paramètres
L’ID de l’utilisateur à rechercher.
Le nombre maximal de résultats.
Ce paramètre permet d’obtenir la « page » de résultats suivante.
Une liste, séparée par des virgules, de champs Tweet à afficher.
Une liste, séparée par des virgules, de champs à développer.
Une liste, séparée par des virgules, de champs Media à afficher.
Une liste, séparée par des virgules, de champs Poll à afficher.
Une liste, séparée par des virgules, de champs User à afficher.
Une liste, séparée par des virgules, de champs Place à afficher.
Renvoie
IteratorGetLikedPostsResponse
get_list_memberships
Paramètres
L’identifiant de l’utilisateur à rechercher.
Le nombre maximal de résultats.
Ce paramètre est utilisé pour obtenir une « page » spécifique de résultats.
Une liste de champs de Liste à afficher, séparés par des virgules.
Une liste de champs à étendre, séparés par des virgules.
Une liste de champs d’utilisateur à afficher, séparés par des virgules.
Renvoie
IteratorGetListMembershipsResponse
get_me
Paramètres
Une liste, séparée par des virgules, des champs utilisateur à afficher.
Une liste, séparée par des virgules, des champs à étendre.
Une liste, séparée par des virgules, des champs de Tweet à afficher.
Valeur renvoyée
GetMeResponse - Données de réponse
get_mentions
Parameters
L’identifiant de l’utilisateur à rechercher.
L’ID de Publication minimal à inclure dans l’ensemble de résultats. Ce paramètre a la priorité sur start_time si les deux sont spécifiés.
L’ID de Publication maximal à inclure dans l’ensemble de résultats. Ce paramètre a la priorité sur end_time si les deux sont spécifiés.
Le nombre maximal de résultats.
Ce paramètre est utilisé pour récupérer la « page » de résultats suivante.
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien à partir duquel les Publications seront renvoyées. Le paramètre since_id a la priorité s’il est également spécifié.
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent jusqu’auquel les Publications seront renvoyées. Le paramètre until_id a la priorité s’il est également spécifié.
Une liste de champs de Tweet, séparés par des virgules, à afficher.
Une liste de champs, séparés par des virgules, à développer.
Une liste de champs Media, séparés par des virgules, à afficher.
Une liste de champs Poll, séparés par des virgules, à afficher.
Une liste de champs User, séparés par des virgules, à afficher.
Une liste de champs Place, séparés par des virgules, à afficher.
Retourne
IteratorGetMentionsResponse
get_muting
Paramètres
L’ID de l’utilisateur source authentifié pour lequel les résultats seront renvoyés.
Le nombre maximal de résultats.
Ce paramètre permet d’obtenir la « page » de résultats suivante.
Une liste, séparée par des virgules, de champs User à afficher.
Une liste, séparée par des virgules, de champs à étendre.
Une liste, séparée par des virgules, de champs Tweet à afficher.
Renvoie
IteratorGetMutingResponse
get_owned_lists
Paramètres
L’identifiant de l’utilisateur à rechercher.
Le nombre maximal de résultats.
Ce paramètre permet d’obtenir une « page » spécifique de résultats.
Une liste de champs de Liste, séparés par des virgules, à afficher.
Une liste de champs, séparés par des virgules, à développer.
Une liste de champs d’Utilisateur, séparés par des virgules, à afficher.
Renvoie
IteratorGetOwnedListsResponse
get_pinned_lists
Paramètres
L’ID de l’utilisateur source authentifié dont il faut renvoyer les résultats.
Une liste de champs de Liste, séparés par des virgules, à afficher.
Une liste de champs, séparés par des virgules, à étendre.
Une liste de champs d’utilisateur, séparés par des virgules, à afficher.
Renvoie
GetPinnedListsResponse - Données de réponse
get_posts
Paramètres
L’ID de l’utilisateur à récupérer.
L’ID minimum de Publication à inclure dans le jeu de résultats. Ce paramètre a priorité sur start_time si les deux sont spécifiés.
L’ID maximum de Publication à inclure dans le jeu de résultats. Ce paramètre a priorité sur end_time si les deux sont spécifiés.
Le nombre maximal de résultats.
Ce paramètre est utilisé pour obtenir la « page » suivante de résultats.
L’ensemble d’entités à exclure (par exemple « replies » ou « retweets »).
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien à partir duquel les Publications seront renvoyées. Le paramètre since_id est prioritaire s’il est également spécifié.
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent jusqu’auquel les Publications seront renvoyées. Le paramètre until_id est prioritaire s’il est également spécifié.
Une liste de champs de Tweet, séparés par des virgules.
Une liste de champs à étendre, séparés par des virgules.
Une liste de champs de média à afficher, séparés par des virgules.
Une liste de champs de sondage à afficher, séparés par des virgules.
Une liste de champs d’utilisateur à afficher, séparés par des virgules.
Une liste de champs de lieu à afficher, séparés par des virgules.
Renvoie
IteratorGetPostsResponse
get_reposts_of_me
Paramètres
Le nombre maximal de résultats.
Ce paramètre permet d’obtenir la « page » suivante de résultats.
Une liste de champs de Tweet, séparés par des virgules, à afficher.
Une liste de champs à étendre, séparés par des virgules.
Une liste de champs de média, séparés par des virgules, à afficher.
Une liste de champs de sondage, séparés par des virgules, à afficher.
Une liste de champs d’utilisateur, séparés par des virgules, à afficher.
Une liste de champs de lieu, séparés par des virgules, à afficher.
Retourne
IteratorGetRepostsOfMeResponse
get_timeline
Paramètres
L’identifiant de l’utilisateur source authentifié pour lequel lister les Publications de la timeline en ordre chronologique inversé.
L’identifiant minimal de Publication à inclure dans l’ensemble de résultats. Ce paramètre a priorité sur start_time si les deux sont spécifiés.
L’identifiant maximal de Publication à inclure dans l’ensemble de résultats. Ce paramètre a priorité sur end_time si les deux sont spécifiés.
Le nombre maximal de résultats.
Ce paramètre est utilisé pour obtenir la « page » suivante de résultats.
L’ensemble des entités à exclure (par exemple « replies » ou « retweets »).
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien à partir duquel les Publications seront renvoyées. Le paramètre since_id a priorité s’il est également spécifié.
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent jusqu’auquel les Publications seront renvoyées. Le paramètre until_id a priorité s’il est également spécifié.
Une liste de champs de Tweet séparés par des virgules à afficher.
Une liste de champs à étendre, séparés par des virgules.
Une liste de champs de Media séparés par des virgules à afficher.
Une liste de champs de Poll séparés par des virgules à afficher.
Une liste de champs d’User séparés par des virgules à afficher.
Une liste de champs de Place séparés par des virgules à afficher.
Renvoie
IteratorGetTimelineResponse
like_post
Paramètres
L’identifiant de l’utilisateur source authentifié qui demande à ajouter un J’aime à la Publication.
Corps de la requête
mute_user
Paramètres
L’identifiant de l’Utilisateur source authentifié qui demande la mise en sourdine de l’Utilisateur cible.
Corps de la requête
pin_list
Paramètres
L’identifiant de l’utilisateur source authentifié qui épinglera la liste.
Corps de la requête
repost_post
Paramètres
L’identifiant de l’Utilisateur source authentifié qui demande à repartager la Publication.
Corps de la requête
search
Paramètres
La chaîne de requête avec laquelle rechercher des utilisateurs.
Le nombre maximal de résultats.
Ce paramètre est utilisé pour obtenir la « page » suivante de résultats. La valeur utilisée avec le paramètre est extraite directement de la réponse fournie par l’API et ne doit pas être modifiée.
Une liste de champs d’utilisateur, séparés par des virgules, à afficher.
Une liste de champs à étendre, séparés par des virgules.
Une liste de champs de Tweet, séparés par des virgules, à afficher.
Renvoie
IteratorSearchResponse
unblock_dms
Paramètres
L’identifiant de l’utilisateur cible dont l’utilisateur authentifié demande la levée du blocage des DMs.
Renvoie
UnblockDmsResponse - Données de la réponse
unfollow_list
Paramètres
L’identifiant de l’Utilisateur source authentifié qui arrêtera de suivre la Liste.
L’identifiant de la Liste à ne plus suivre.
Renvoie
UnfollowListResponse - Données de la réponse
unfollow_user
Paramètres
L’identifiant de l’Utilisateur source authentifié qui demande à se désabonner de l’Utilisateur cible.
L’identifiant de l’Utilisateur dont l’Utilisateur source demande à se désabonner.
Renvoie
UnfollowUserResponse - Données de la réponse
unlike_post
Paramètres
L’identifiant de l’Utilisateur source authentifié qui demande à retirer son like de la Publication.
L’identifiant de la Publication pour laquelle l’Utilisateur demande à retirer son like.
Renvoie
UnlikePostResponse - Données de la réponse
unmute_user
Paramètres
L’identifiant de l’Utilisateur source authentifié qui demande d’annuler la mise en sourdine de l’Utilisateur cible.
L’identifiant de l’Utilisateur dont l’Utilisateur source demande d’annuler la mise en sourdine.
Renvoie
UnmuteUserResponse - Données de la réponse
unpin_list
Paramètres
L’identifiant de l’utilisateur source authentifié pour lequel retourner les résultats.
L’identifiant de la Liste à détacher.
Renvoie
UnpinListResponse - Données de réponse
unrepost_post
Paramètres
L’identifiant de l’utilisateur source authentifié qui demande de repartager la Publication.
L’identifiant de la Publication dont l’utilisateur demande l’annulation du Retweet.
Renvoie
UnrepostPostResponse - Données de réponse