XpozClient (sync) and AsyncXpozClient (async). Async methods have the same signature but return awaitables.
Twitter — client.twitter
Available Fields
The Python SDK accepts snake_case field names and automatically maps them to the camelCase names used by the underlying MCP server.
User Fields
Pass these in thefields parameter on any user method (get_user, search_users, get_user_connections, get_users_by_keywords, get_post_interacting_users).
Default: id, username, name
get_users_by_keywords also returns aggregation fields: agg_relevance, relevant_tweets_count, relevant_tweets_impressions_sum, relevant_tweets_likes_sum, relevant_tweets_quotes_sum, relevant_tweets_replies_sum, relevant_tweets_retweets_sum.
Post Fields
Pass these in thefields parameter on any post method (get_posts_by_ids, get_posts_by_author, search_posts, get_retweets, get_quotes, get_comments).
Default: id, text, author_username, created_at_date
get_user
Get a single Twitter user profile.- Sync
- Async
Returns:
TwitterUser
search_users
Search users by name or username.
Returns:
list[TwitterUser]
get_user_connections
Get followers or following for a user.
Returns:
PaginatedResult[TwitterUser]
get_users_by_keywords
Find users who authored posts matching a keyword query. Includes aggregation fields likerelevant_tweets_count and relevant_tweets_likes_sum.
Returns:
PaginatedResult[TwitterUser]
get_posts_by_ids
Get 1-100 posts by their IDs.
Returns:
list[TwitterPost]
get_posts_by_author
Get all posts by an author with optional date filtering.- Sync
- Async
Returns:
PaginatedResult[TwitterPost]
search_posts
Full-text search across Twitter posts with filters.
Returns:
PaginatedResult[TwitterPost]
get_retweets
Get retweets of a specific post.
Returns:
PaginatedResult[TwitterPost]
get_quotes
Get quote tweets of a specific post.
Returns:
PaginatedResult[TwitterPost]
get_comments
Get replies to a specific post.
Returns:
PaginatedResult[TwitterPost]
get_post_interacting_users
Get users who interacted with a post.
Returns:
PaginatedResult[TwitterUser]
count_posts
Count tweets containing a phrase within a date range.
Returns:
int
Instagram — client.instagram
Available Fields
The Python SDK accepts snake_case field names and automatically maps them to the camelCase names used by the underlying MCP server.
User Fields
Pass these in thefields parameter on any user method (get_user, search_users, get_user_connections, get_post_interacting_users, get_users_by_keywords).
Default: id, username, full_name
get_users_by_keywords also returns aggregation fields: agg_relevance, relevant_posts_count, relevant_posts_likes_sum, relevant_posts_comments_sum, relevant_posts_reshares_sum, relevant_posts_video_plays_sum.
Post Fields
Pass these in thefields parameter on any post method (get_posts_by_ids, get_posts_by_user, search_posts).
Default: id, caption, username, created_at_date
Comment Fields
Pass these in thefields parameter on get_comments.
Default: id, text, username, created_at_date
get_user
Get a single Instagram user profile.
Returns:
InstagramUser
search_users
Search Instagram users by name.
Returns:
list[InstagramUser]
get_user_connections
Get followers or following for an Instagram user.
Returns:
PaginatedResult[InstagramUser]
get_users_by_keywords
Find users who authored posts matching a keyword query.
Returns:
PaginatedResult[InstagramUser]
get_posts_by_ids
Get Instagram posts by their IDs. Post IDs must be in strong_id format:"media_id_user_id".
Returns:
list[InstagramPost]
get_posts_by_user
Get all posts by an Instagram user.
Returns:
PaginatedResult[InstagramPost]
search_posts
Full-text search across Instagram posts.
Returns:
PaginatedResult[InstagramPost]
get_comments
Get comments on an Instagram post.
Returns:
PaginatedResult[InstagramComment]
get_post_interacting_users
Get users who interacted with an Instagram post.
Returns:
PaginatedResult[InstagramUser]
Reddit — client.reddit
Available Fields
The Python SDK accepts snake_case field names and automatically maps them to the camelCase names used by the underlying MCP server.
User Fields
Pass these in thefields parameter on any user method (get_user, search_users, get_users_by_keywords).
Default: id, username, total_karma
get_users_by_keywords also returns aggregation fields: agg_relevance, relevant_posts_count, relevant_posts_upvotes_sum, relevant_posts_comments_count_sum.
Post Fields
Pass these in thefields parameter on post methods (search_posts) or the post_fields parameter on get_post_with_comments and get_subreddit_with_posts.
Default: id, title, author_username, subreddit_name, created_at_date
Comment Fields
Pass these in thefields parameter on search_comments or the comment_fields parameter on get_post_with_comments.
Default: id, body, author_username, created_at_date
Subreddit Fields
Pass these in thefields parameter on subreddit methods (search_subreddits, get_subreddits_by_keywords) or the subreddit_fields parameter on get_subreddit_with_posts.
Default: id, display_name, title, subscribers_count
get_subreddits_by_keywords also returns aggregation fields: agg_relevance, relevant_posts_count, relevant_posts_upvotes_sum, relevant_posts_comments_count_sum.
get_user
Get a single Reddit user profile.
Returns:
RedditUser
search_users
Search Reddit users by name.
Returns:
list[RedditUser]
get_users_by_keywords
Find Reddit users who authored posts matching a keyword query.
Returns:
PaginatedResult[RedditUser]
search_posts
Full-text search across Reddit posts.
Returns:
PaginatedResult[RedditPost]
get_post_with_comments
Get a Reddit post with its comments.
Returns:
RedditPostWithComments
The returned object contains:
post—RedditPostcomments—list[RedditComment]comments_pagination—PaginationInfo | None
search_comments
Search Reddit comments by keyword.
Returns:
PaginatedResult[RedditComment]
search_subreddits
Search subreddits by name.
Returns:
list[RedditSubreddit]
get_subreddit_with_posts
Get a subreddit with its posts.
Returns:
SubredditWithPosts
The returned object contains:
subreddit—RedditSubredditposts—list[RedditPost]posts_pagination—PaginationInfo | None
get_subreddits_by_keywords
Find subreddits related to a keyword query.
Returns:
PaginatedResult[RedditSubreddit]
TikTok — client.tiktok
Available Fields
The Python SDK accepts snake_case field names and automatically maps them to the camelCase names used by the underlying MCP server.
User Fields
Pass these in thefields parameter on any user method (get_user, search_users, get_users_by_keywords, get_users_by_hashtags).
Default: id, username, nickname
get_users_by_keywords and get_users_by_hashtags also return aggregation fields: agg_relevance, relevant_posts_count, relevant_posts_likes_sum, relevant_posts_comments_sum, relevant_posts_plays_sum, relevant_posts_forwards_sum.
Post Fields
Pass these in thefields parameter on any post method (get_posts_by_ids, get_posts_by_user, search_posts, get_posts_by_hashtags).
Default: id, description, username, created_at_date
Comment Fields
Pass these in thefields parameter on get_comments.
Default: id, text, username, created_at_date
get_user
Get a single TikTok user profile.
Returns:
TiktokUser
search_users
Search TikTok users by name.
Returns:
list[TiktokUser]
get_users_by_keywords
Find TikTok users who authored posts matching a keyword query.
Returns:
PaginatedResult[TiktokUser]
get_posts_by_ids
Get 1-100 TikTok posts by their IDs.
Returns:
list[TiktokPost]
get_posts_by_user
Get all posts by a TikTok user.
Returns:
PaginatedResult[TiktokPost]
search_posts
Full-text search across TikTok posts.
Returns:
PaginatedResult[TiktokPost]
get_posts_by_hashtags
Search TikTok posts by hashtags. Pass bare alphanumeric tags (no leading#). Max 5 hashtags per request; OR semantics across the list.
Returns:
PaginatedResult[TiktokPost]
get_users_by_hashtags
Find TikTok users who authored posts tagged with the given hashtags. Same input rules asget_posts_by_hashtags.
Returns:
PaginatedResult[TiktokUser]
get_comments
Get comments on a TikTok post.
Returns:
PaginatedResult[TiktokComment]
Type Models
All models are Pydantic v2BaseModel subclasses with extra="allow" (unknown fields are preserved). All fields are Optional and default to None. Field names use snake_case.
TwitterPost
TwitterUser
InstagramPost
InstagramUser
InstagramComment
RedditPost
RedditUser
RedditComment
RedditSubreddit
TiktokPost
TiktokUser
TiktokComment
Composite Types
RedditPostWithComments — returned by get_post_with_comments():
post: RedditPostcomments: list[RedditComment]comments_pagination: PaginationInfo | None
SubredditWithPosts — returned by get_subreddit_with_posts():
subreddit: RedditSubredditposts: list[RedditPost]posts_pagination: PaginationInfo | None
For the TypeScript equivalent of these types, see TypeScript SDK Reference. The TypeScript SDK uses plain interfaces with camelCase field names (e.g.,
likeCount instead of like_count).
