Skip to main content

​
Submodules

​
Module contents

This module provides access to the posts endpoints of the X API and serves as the main entry point for all posts-related functionality.

​
class xdk.posts.PostsClient

Client for posts operations

​
Parameters

​
path.client
Client

​
__init__

​
Parameters

​
path.client
Client

​
create

Create or Edit Post Creates a new Post for the authenticated user, or edits an existing Post when edit_options are provided. body: Request body :returns: Response data :rtype: CreateResponse

​
Parameters

​
body.body
CreateRequest

​
delete

Delete Post Deletes a specific Post by its ID, if owned by the authenticated user.

​
Parameters

​
path.id
Any
The ID of the Post to be deleted.

​
Returns

DeleteResponse - Response data

​
get_analytics

Get Post analytics Retrieves analytics data for specified Posts within a defined time range.

​
Parameters

​
path.ids
List
A comma separated list of Post IDs. Up to 100 are allowed in a single request.
​
path.end_time
str
YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the end of the time range.
​
path.start_time
str
YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the start of the time range.
​
path.granularity
str
The granularity for the search counts results.
​
path.analytics_fields
List or None
default:"None"
A comma separated list of Analytics fields to display.

​
Returns

GetAnalyticsResponse - Response data

​
get_by_id

Get Post by ID Retrieves details of a specific Post by its ID.

​
Parameters

​
path.id
Any
A single Post ID.
​
path.tweet_fields
List or None
default:"None"
A comma separated list of Tweet fields to display.
​
path.expansions
List or None
default:"None"
A comma separated list of fields to expand.
​
path.media_fields
List or None
default:"None"
A comma separated list of Media fields to display.
​
path.poll_fields
List or None
default:"None"
A comma separated list of Poll fields to display.
​
path.user_fields
List or None
default:"None"
A comma separated list of User fields to display.
​
path.place_fields
List or None
default:"None"
A comma separated list of Place fields to display.

​
Returns

GetByIdResponse - Response data

​
get_by_ids

Get Posts by IDs Retrieves details of multiple Posts by their IDs.

​
Parameters

​
path.ids
List
A comma separated list of Post IDs. Up to 100 are allowed in a single request.
​
path.tweet_fields
List or None
default:"None"
A comma separated list of Tweet fields to display.
​
path.expansions
List or None
default:"None"
A comma separated list of fields to expand.
​
path.media_fields
List or None
default:"None"
A comma separated list of Media fields to display.
​
path.poll_fields
List or None
default:"None"
A comma separated list of Poll fields to display.
​
path.user_fields
List or None
default:"None"
A comma separated list of User fields to display.
​
path.place_fields
List or None
default:"None"
A comma separated list of Place fields to display.

​
Returns

GetByIdsResponse - Response data

​
get_counts_all

Get count of all Posts Retrieves the count of Posts matching a search query from the full archive.

​
Parameters

​
path.query
str
One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
​
path.start_time
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp (from most recent 7 days) from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
​
path.end_time
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
​
path.since_id
Any or None
default:"None"
Returns results with a Post ID greater than (that is, more recent than) the specified ID.
​
path.until_id
Any or None
default:"None"
Returns results with a Post ID less than (that is, older than) the specified ID.
​
path.next_token
Any or None
default:"None"
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.
​
path.pagination_token
Any or None
default:"None"
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.
​
path.granularity
str or None
default:"None"
The granularity for the search counts results.
​
path.search_count_fields
List or None
default:"None"
A comma separated list of SearchCount fields to display.

​
Returns

GetCountsAllResponse - Response data

​
get_counts_recent

Get count of recent Posts Retrieves the count of Posts from the last 7 days matching a search query.

​
Parameters

​
path.query
str
One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
​
path.start_time
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp (from most recent 7 days) from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
​
path.end_time
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
​
path.since_id
Any or None
default:"None"
Returns results with a Post ID greater than (that is, more recent than) the specified ID.
​
path.until_id
Any or None
default:"None"
Returns results with a Post ID less than (that is, older than) the specified ID.
​
path.next_token
Any or None
default:"None"
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.
​
path.pagination_token
Any or None
default:"None"
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.
​
path.granularity
str or None
default:"None"
The granularity for the search counts results.
​
path.search_count_fields
List or None
default:"None"
A comma separated list of SearchCount fields to display.

​
Returns

GetCountsRecentResponse - Response data

​
get_insights28hr

Get 28-hour Post insights Retrieves engagement metrics for specified Posts over the last 28 hours.

​
Parameters

​
path.tweet_ids
List
List of PostIds for 28hr metrics.
​
path.granularity
str
granularity of metrics response.
​
path.requested_metrics
List
request metrics for historical request.
​
path.engagement_fields
List or None
default:"None"
A comma separated list of Engagement fields to display.

​
Returns

GetInsights28hrResponse - Response data

​
get_insights_historical

Get historical Post insights Retrieves historical engagement metrics for specified Posts within a defined time range.

​
Parameters

​
path.tweet_ids
List
List of PostIds for historical metrics.
​
path.end_time
str
YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the end of the time range.
​
path.start_time
str
YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the start of the time range.
​
path.granularity
str
granularity of metrics response.
​
path.requested_metrics
List
request metrics for historical request.
​
path.engagement_fields
List or None
default:"None"
A comma separated list of Engagement fields to display.

​
Returns

GetInsightsHistoricalResponse - Response data

​
get_liking_users

Get Liking Users Retrieves a list of Users who liked a specific Post by its ID.

​
Parameters

​
path.id
Any
A single Post ID.
​
path.max_results
int or None
default:"None"
The maximum number of results.
​
path.pagination_token
Any or None
default:"None"
This parameter is used to get the next ‘page’ of results.
​
path.user_fields
List or None
default:"None"
A comma separated list of User fields to display.
​
path.expansions
List or None
default:"None"
A comma separated list of fields to expand.
​
path.tweet_fields
List or None
default:"None"
A comma separated list of Tweet fields to display.

​
Returns

GetLikingUsersResponse - Response data

​
get_quoted

Get Quoted Posts Retrieves a list of Posts that quote a specific Post by its ID.

​
Parameters

​
path.id
Any
A single Post ID.
​
path.max_results
int or None
default:"None"
The maximum number of results to be returned.
​
path.pagination_token
Any or None
default:"None"
This parameter is used to get a specified ‘page’ of results.
​
path.exclude
List or None
default:"None"
The set of entities to exclude (e.g. ‘replies’ or ‘retweets’).
​
path.tweet_fields
List or None
default:"None"
A comma separated list of Tweet fields to display.
​
path.expansions
List or None
default:"None"
A comma separated list of fields to expand.
​
path.media_fields
List or None
default:"None"
A comma separated list of Media fields to display.
​
path.poll_fields
List or None
default:"None"
A comma separated list of Poll fields to display.
​
path.user_fields
List or None
default:"None"
A comma separated list of User fields to display.
​
path.place_fields
List or None
default:"None"
A comma separated list of Place fields to display.

​
Returns

GetQuotedResponse - Response data

​
get_reposted_by

Get Reposted by Retrieves a list of Users who reposted a specific Post by its ID.

​
Parameters

​
path.id
Any
A single Post ID.
​
path.max_results
int or None
default:"None"
The maximum number of results.
​
path.pagination_token
Any or None
default:"None"
This parameter is used to get the next ‘page’ of results.
​
path.user_fields
List or None
default:"None"
A comma separated list of User fields to display.
​
path.expansions
List or None
default:"None"
A comma separated list of fields to expand.
​
path.tweet_fields
List or None
default:"None"
A comma separated list of Tweet fields to display.

​
Returns

GetRepostedByResponse - Response data

​
get_reposts

Get Reposts Retrieves a list of Posts that repost a specific Post by its ID.

​
Parameters

​
path.id
Any
A single Post ID.
​
path.max_results
int or None
default:"None"
The maximum number of results.
​
path.pagination_token
Any or None
default:"None"
This parameter is used to get the next ‘page’ of results.
​
path.tweet_fields
List or None
default:"None"
A comma separated list of Tweet fields to display.
​
path.expansions
List or None
default:"None"
A comma separated list of fields to expand.
​
path.media_fields
List or None
default:"None"
A comma separated list of Media fields to display.
​
path.poll_fields
List or None
default:"None"
A comma separated list of Poll fields to display.
​
path.user_fields
List or None
default:"None"
A comma separated list of User fields to display.
​
path.place_fields
List or None
default:"None"
A comma separated list of Place fields to display.

​
Returns

GetRepostsResponse - Response data

​
hide_reply

Hide reply Hides or unhides a reply to a conversation owned by the authenticated user.

​
Parameters

​
path.tweet_id
Any
The ID of the reply that you want to hide or unhide.
​
body.body
HideReplyRequest
Request body

​
search_all

Search all Posts Retrieves Posts from the full archive matching a search query.

​
Parameters

​
path.query
str
One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
​
path.start_time
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
​
path.end_time
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
​
path.since_id
Any or None
default:"None"
Returns results with a Post ID greater than (that is, more recent than) the specified ID.
​
path.until_id
Any or None
default:"None"
Returns results with a Post ID less than (that is, older than) the specified ID.
​
path.max_results
int or None
default:"None"
The maximum number of search results to be returned by a request.
​
path.next_token
Any or None
default:"None"
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.
​
path.pagination_token
Any or None
default:"None"
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.
​
path.sort_order
str or None
default:"None"
This order in which to return results.
​
path.tweet_fields
List or None
default:"None"
A comma separated list of Tweet fields to display.
​
path.expansions
List or None
default:"None"
A comma separated list of fields to expand.
​
path.media_fields
List or None
default:"None"
A comma separated list of Media fields to display.
​
path.poll_fields
List or None
default:"None"
A comma separated list of Poll fields to display.
​
path.user_fields
List or None
default:"None"
A comma separated list of User fields to display.
​
path.place_fields
List or None
default:"None"
A comma separated list of Place fields to display.

​
Returns

SearchAllResponse - Response data

​
search_recent

Search recent Posts Retrieves Posts from the last 7 days matching a search query.

​
Parameters

​
path.query
str
One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
​
path.start_time
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
​
path.end_time
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
​
path.since_id
Any or None
default:"None"
Returns results with a Post ID greater than (that is, more recent than) the specified ID.
​
path.until_id
Any or None
default:"None"
Returns results with a Post ID less than (that is, older than) the specified ID.
​
path.max_results
int or None
default:"None"
The maximum number of search results to be returned by a request.
​
path.next_token
Any or None
default:"None"
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.
​
path.pagination_token
Any or None
default:"None"
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.
​
path.sort_order
str or None
default:"None"
This order in which to return results.
​
path.tweet_fields
List or None
default:"None"
A comma separated list of Tweet fields to display.
​
path.expansions
List or None
default:"None"
A comma separated list of fields to expand.
​
path.media_fields
List or None
default:"None"
A comma separated list of Media fields to display.
​
path.poll_fields
List or None
default:"None"
A comma separated list of Poll fields to display.
​
path.user_fields
List or None
default:"None"
A comma separated list of User fields to display.
​
path.place_fields
List or None
default:"None"
A comma separated list of Place fields to display.

​
Returns

SearchRecentResponse - Response data