x_get_account_activity_subscription_count
Get subscription count
- Operation
- Read
read - Full name
x.x_get_account_activity_subscription_count
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
social
Agent-facing Lua documentation and function reference for the Twitter / X KosmoKrator integration.
Agents call this integration through app.integrations.x.*.
Use lua_read_doc("integrations.x") inside KosmoKrator to discover the same reference at runtime.
This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.
This integration is generated from the official X OpenAPI document version 2.162 and exposes 162 X API operations.
Configure one or more credential modes:
bearer_token for app-only public reads.access_token for OAuth 2.0 user-context operations.api_key, api_secret, access_token, and access_token_secret for OAuth 1.0a user-context operations.Each tool carries auth_modes, required_scopes, and runtime_mode metadata in the generated catalog.
stream require a host streaming runner.webhook_subscription require a public callback endpoint.local me = app.integrations.x.x_get_users_me({})
local user = app.integrations.x.x_get_users_by_username({ username = "XDevelopers" })
For multi-account hosts:
app.integrations.x.default.x_find_my_user({})
app.integrations.x.work.x_find_my_user({})# Twitter / X — Lua API Reference
This integration is generated from the official X OpenAPI document version `2.162` and exposes 162 X API operations.
## Authentication
Configure one or more credential modes:
- `bearer_token` for app-only public reads.
- `access_token` for OAuth 2.0 user-context operations.
- `api_key`, `api_secret`, `access_token`, and `access_token_secret` for OAuth 1.0a user-context operations.
Each tool carries `auth_modes`, `required_scopes`, and `runtime_mode` metadata in the generated catalog.
## Runtime Notes
- Tools marked `stream` require a host streaming runner.
- Tools marked `webhook_subscription` require a public callback endpoint.
- Enterprise or approved-access endpoints return clear API errors if the configured X account lacks access.
## Examples
```lua
local me = app.integrations.x.x_get_users_me({})
local user = app.integrations.x.x_get_users_by_username({ username = "XDevelopers" })
```
For multi-account hosts:
```lua
app.integrations.x.default.x_find_my_user({})
app.integrations.x.work.x_find_my_user({})
``` local result = app.integrations.x.x_get_account_activity_subscription_count({})
print(result) x_get_account_activity_subscription_countGet subscription count
readx.x_get_account_activity_subscription_count| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
x_validate_account_activity_subscriptionValidate subscription
readx.x_validate_account_activity_subscription| Parameter | Type | Required | Description |
|---|---|---|---|
webhook_id | string | yes | The webhook ID to check subscription against. |
x_create_account_activity_subscriptionCreate subscription
writex.x_create_account_activity_subscription| Parameter | Type | Required | Description |
|---|---|---|---|
webhook_id | string | yes | The webhook ID to check subscription against. |
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_get_account_activity_subscriptionsGet subscriptions
readx.x_get_account_activity_subscriptions| Parameter | Type | Required | Description |
|---|---|---|---|
webhook_id | string | yes | The webhook ID to pull subscriptions for. |
x_delete_account_activity_subscriptionDelete subscription
writex.x_delete_account_activity_subscription| Parameter | Type | Required | Description |
|---|---|---|---|
webhook_id | string | yes | The webhook ID to check subscription against. |
user_id | string | yes | User ID to unsubscribe from. |
x_activity_streamActivity Stream
readx.x_activity_stream| Parameter | Type | Required | Description |
|---|---|---|---|
backfill_minutes | integer | no | The number of minutes of backfill requested. |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post labels will be provided. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Post labels will be provided. |
x_delete_activity_subscriptions_by_idsDelete X activity subscriptions by IDs
writex.x_delete_activity_subscriptions_by_ids| Parameter | Type | Required | Description |
|---|---|---|---|
ids | array | yes | Comma-separated list of subscription IDs to delete. |
x_get_activity_subscriptionsGet X activity subscriptions
readx.x_get_activity_subscriptions| Parameter | Type | Required | Description |
|---|---|---|---|
max_results | integer | no | The maximum number of results to return per page. |
pagination_token | string | no | This parameter is used to get the next 'page' of results. |
x_create_activity_subscriptionCreate X activity subscription
writex.x_create_activity_subscription| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_delete_activity_subscriptionDeletes X activity subscription
writex.x_delete_activity_subscription| Parameter | Type | Required | Description |
|---|---|---|---|
subscription_id | string | yes | The ID of the subscription to delete. |
x_update_activity_subscriptionUpdate X activity subscription
writex.x_update_activity_subscription| Parameter | Type | Required | Description |
|---|---|---|---|
subscription_id | string | yes | The ID of the subscription to update. |
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_get_chat_conversationsGet Chat Conversations
readx.x_get_chat_conversations| Parameter | Type | Required | Description |
|---|---|---|---|
max_results | integer | no | Maximum number of conversations to return. |
pagination_token | string | no | Token for pagination to retrieve the next page of results. |
chat_conversation.fields | array | no | A comma separated list of ChatConversation fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
user.fields | array | no | A comma separated list of User fields to display. |
x_create_chat_conversationCreate Chat Group Conversation
writex.x_create_chat_conversation| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | yes | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_initialize_chat_groupInitialize Chat Group
writex.x_initialize_chat_group| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
x_get_chat_conversationGet Chat Conversation
readx.x_get_chat_conversation| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The recipient's user ID for a 1:1 conversation, or a group conversation ID (prefixed with 'g'). |
max_results | integer | no | Maximum number of message events to return. |
pagination_token | string | no | Token for pagination to retrieve the next page of results. |
chat_message_event.fields | array | no | A comma separated list of ChatMessageEvent fields to display. |
x_initialize_chat_conversation_keysInitialize Conversation Keys
writex.x_initialize_chat_conversation_keys| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The recipient's user ID for a 1:1 conversation, or a group conversation ID (prefixed with 'g'). |
body | object | yes | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_add_chat_group_membersAdd members to a Chat group conversation
writex.x_add_chat_group_members| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The Chat group conversation ID. |
body | object | yes | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_send_chat_messageSend Chat Message
writex.x_send_chat_message| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The recipient's user ID for a 1:1 conversation, or a group conversation ID (prefixed with 'g'). |
body | object | yes | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_mark_chat_conversation_readMark Conversation as Read
writex.x_mark_chat_conversation_read| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The recipient's user ID for a 1:1 conversation, or a group conversation ID (prefixed with 'g'). |
body | object | yes | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_send_chat_typing_indicatorSend Typing Indicator
writex.x_send_chat_typing_indicator| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The recipient's user ID for a 1:1 conversation, or a group conversation ID (prefixed with 'g'). |
x_chat_media_upload_initializeInitialize Chat Media Upload
writex.x_chat_media_upload_initialize| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | yes | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_chat_media_upload_appendAppend Chat Media Upload
writex.x_chat_media_upload_append| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The session/resume id from initialize. |
body | object | yes | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_chat_media_upload_finalizeFinalize Chat Media Upload
writex.x_chat_media_upload_finalize| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The session/resume id from initialize. |
body | object | yes | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_chat_media_downloadDownload Chat Media
readx.x_chat_media_download| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The recipient's user ID for a 1:1 conversation, or a group conversation ID (prefixed with 'g'). |
media_hash_key | string | yes | The media hash key returned from the upload initialize step. |
x_search_communitiesSearch Communities
readx.x_search_communities| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | yes | Query to search communities. |
max_results | integer | no | The maximum number of search results to be returned by a request. |
next_token | string | no | 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. |
pagination_token | string | no | 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. |
community.fields | array | no | A comma separated list of Community fields to display. |
x_get_communities_by_idGet Community by ID
readx.x_get_communities_by_id| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the Community. |
community.fields | array | no | A comma separated list of Community fields to display. |
x_get_compliance_jobsGet Compliance Jobs
readx.x_get_compliance_jobs| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | yes | Type of Compliance Job to list. |
status | string | no | Status of Compliance Job to list. |
compliance_job.fields | array | no | A comma separated list of ComplianceJob fields to display. |
x_create_compliance_jobsCreate Compliance Job
writex.x_create_compliance_jobs| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | yes | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_get_compliance_jobs_by_idGet Compliance Job by ID
readx.x_get_compliance_jobs_by_id| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the Compliance Job to retrieve. |
compliance_job.fields | array | no | A comma separated list of ComplianceJob fields to display. |
x_delete_connections_by_uuidsTerminate multiple connections
writex.x_delete_connections_by_uuids| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | yes | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_get_connection_historyGet Connection History
readx.x_get_connection_history| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | no | Filter by connection status. Use 'active' for current connections, 'inactive' for historical/disconnected connections, or 'all' for both. |
endpoints | array | no | Filter by streaming endpoint. Specify one or more endpoint names to filter results. |
max_results | integer | no | The maximum number of results to return per page. |
pagination_token | string | no | Token for paginating through results. Use the value from 'next_token' in the previous response. |
connection.fields | array | no | A comma separated list of Connection fields to display. |
x_delete_all_connectionsTerminate all connections
writex.x_delete_all_connections| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
x_delete_connections_by_endpointTerminate connections by endpoint
writex.x_delete_connections_by_endpoint| Parameter | Type | Required | Description |
|---|---|---|---|
endpoint_id | string | yes | The endpoint ID to terminate connections for. |
x_create_direct_messages_conversationCreate DM conversation
writex.x_create_direct_messages_conversation| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_dm_conversations_media_downloadDownload DM Media
readx.x_dm_conversations_media_download| Parameter | Type | Required | Description |
|---|---|---|---|
dm_id | string | yes | The unique identifier of the Direct Message event containing the media. |
media_id | string | yes | The unique identifier of the media attached to the Direct Message. |
resource_id | string | yes | The resource identifier of the media file, including file extension (e.g. 'hVJQTwig.jpg'). |
x_get_direct_messages_events_by_participant_idGet DM events for a DM conversation
readx.x_get_direct_messages_events_by_participant_id| Parameter | Type | Required | Description |
|---|---|---|---|
participant_id | string | yes | The ID of the participant user for the One to One DM conversation. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get a specified 'page' of results. |
event_types | array | no | The set of event_types to include in the results. |
dm_event.fields | array | no | A comma separated list of DmEvent fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_create_direct_messages_by_participant_idCreate DM message by participant ID
writex.x_create_direct_messages_by_participant_id| Parameter | Type | Required | Description |
|---|---|---|---|
participant_id | string | yes | The ID of the recipient user that will receive the DM. |
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_create_direct_messages_by_conversation_idCreate DM message by conversation ID
writex.x_create_direct_messages_by_conversation_id| Parameter | Type | Required | Description |
|---|---|---|---|
dm_conversation_id | string | yes | The DM Conversation ID. |
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_get_direct_messages_events_by_conversation_idGet DM events for a DM conversation
readx.x_get_direct_messages_events_by_conversation_id| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The DM conversation ID. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get a specified 'page' of results. |
event_types | array | no | The set of event_types to include in the results. |
dm_event.fields | array | no | A comma separated list of DmEvent fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_get_direct_messages_eventsGet DM events
readx.x_get_direct_messages_events| Parameter | Type | Required | Description |
|---|---|---|---|
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get a specified 'page' of results. |
event_types | array | no | The set of event_types to include in the results. |
dm_event.fields | array | no | A comma separated list of DmEvent fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_delete_direct_messages_eventsDelete DM event
writex.x_delete_direct_messages_events| Parameter | Type | Required | Description |
|---|---|---|---|
event_id | string | yes | The ID of the direct-message event to delete. |
x_get_direct_messages_events_by_idGet DM event by ID
readx.x_get_direct_messages_events_by_id| Parameter | Type | Required | Description |
|---|---|---|---|
event_id | string | yes | dm event id. |
dm_event.fields | array | no | A comma separated list of DmEvent fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_evaluate_community_notesEvaluate a Community Note
writex.x_evaluate_community_notes| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_get_insights28_hrGet 28-hour Post insights
readx.x_get_insights28_hr| Parameter | Type | Required | Description |
|---|---|---|---|
tweet_ids | array | yes | List of PostIds for 28hr metrics. |
granularity | string | yes | granularity of metrics response. |
requested_metrics | array | yes | request metrics for historical request. |
engagement.fields | array | no | A comma separated list of Engagement fields to display. |
x_get_insights_historicalGet historical Post insights
readx.x_get_insights_historical| Parameter | Type | Required | Description |
|---|---|---|---|
tweet_ids | array | yes | List of PostIds for historical metrics. |
end_time | string | yes | YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the end of the time range. |
start_time | string | yes | YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the start of the time range. |
granularity | string | yes | granularity of metrics response. |
requested_metrics | array | yes | request metrics for historical request. |
engagement.fields | array | no | A comma separated list of Engagement fields to display. |
x_stream_likes_complianceStream Likes compliance data
readx.x_stream_likes_compliance| Parameter | Type | Required | Description |
|---|---|---|---|
backfill_minutes | integer | no | The number of minutes of backfill requested. |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Likes Compliance events will be provided. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Likes Compliance events will be provided. |
x_stream_likes_firehoseStream all Likes
readx.x_stream_likes_firehose| Parameter | Type | Required | Description |
|---|---|---|---|
backfill_minutes | integer | no | The number of minutes of backfill requested. |
partition | integer | yes | The partition number. |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. |
like_with_tweet_author.fields | array | no | A comma separated list of LikeWithTweetAuthor fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_stream_likes_sample10Stream sampled Likes
readx.x_stream_likes_sample10| Parameter | Type | Required | Description |
|---|---|---|---|
backfill_minutes | integer | no | The number of minutes of backfill requested. |
partition | integer | yes | The partition number. |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. |
like_with_tweet_author.fields | array | no | A comma separated list of LikeWithTweetAuthor fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_create_listsCreate List
writex.x_create_lists| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_delete_listsDelete List
writex.x_delete_lists| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the List to delete. |
x_get_lists_by_idGet List by ID
readx.x_get_lists_by_id| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the List. |
list.fields | array | no | A comma separated list of List fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
user.fields | array | no | A comma separated list of User fields to display. |
x_update_listsUpdate List
writex.x_update_lists| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the List to modify. |
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_get_lists_followersGet List followers
readx.x_get_lists_followers| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the List. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get a specified 'page' of results. |
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_get_lists_membersGet List members
readx.x_get_lists_members| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the List. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get a specified 'page' of results. |
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_add_lists_memberAdd List member
writex.x_add_lists_member| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the List for which to add a member. |
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_remove_lists_member_by_user_idRemove List member
writex.x_remove_lists_member_by_user_id| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the List to remove a member. |
user_id | string | yes | The ID of User that will be removed from the List. |
x_get_lists_postsGet List Posts
readx.x_get_lists_posts| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the List. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get the next 'page' of results. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_get_media_by_media_keysGet Media by media keys
readx.x_get_media_by_media_keys| Parameter | Type | Required | Description |
|---|---|---|---|
media_keys | array | yes | A comma separated list of Media Keys. Up to 100 are allowed in a single request. |
media.fields | array | no | A comma separated list of Media fields to display. |
x_get_media_analyticsGet Media analytics
readx.x_get_media_analytics| Parameter | Type | Required | Description |
|---|---|---|---|
media_keys | array | yes | A comma separated list of Media Keys. Up to 100 are allowed in a single request. |
end_time | string | yes | YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the end of the time range. |
start_time | string | yes | YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the start of the time range. |
granularity | string | yes | The granularity for the search counts results. |
media_analytics.fields | array | no | A comma separated list of MediaAnalytics fields to display. |
x_create_media_metadataCreate Media metadata
writex.x_create_media_metadata| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_delete_media_subtitlesDelete Media subtitles
writex.x_delete_media_subtitles| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_create_media_subtitlesCreate Media subtitles
writex.x_create_media_subtitles| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_get_media_upload_statusGet Media upload status
readx.x_get_media_upload_status| Parameter | Type | Required | Description |
|---|---|---|---|
media_id | string | yes | Media id for the requested media upload status. |
command | string | no | The command for the media upload request. |
x_media_uploadUpload media
writex.x_media_upload| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_initialize_media_uploadInitialize media upload
writex.x_initialize_media_upload| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_append_media_uploadAppend Media upload
writex.x_append_media_upload| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The media identifier for the media to perform the append operation. |
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_finalize_media_uploadFinalize Media upload
writex.x_finalize_media_upload| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The media id of the targeted media to finalize. |
x_get_media_by_media_keyGet Media by media key
readx.x_get_media_by_media_key| Parameter | Type | Required | Description |
|---|---|---|---|
media_key | string | yes | A single Media Key. |
media.fields | array | no | A comma separated list of Media fields to display. |
x_search_newsSearch News
readx.x_search_news| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | yes | The search query. |
max_results | integer | no | The number of results to return. |
max_age_hours | integer | no | The maximum age of the News story to search for. |
news.fields | array | no | A comma separated list of News fields to display. |
x_get_newsGet news stories by ID
readx.x_get_news| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the news story. |
news.fields | array | no | A comma separated list of News fields to display. |
x_create_community_notesCreate a Community Note
writex.x_create_community_notes| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_search_community_notes_writtenSearch for Community Notes Written
readx.x_search_community_notes_written| Parameter | Type | Required | Description |
|---|---|---|---|
test_mode | boolean | yes | If true, return the notes the caller wrote for the test. If false, return the notes the caller wrote on the product. |
pagination_token | string | no | Pagination token to get next set of posts eligible for notes. |
max_results | integer | no | Max results to return. |
note.fields | array | no | A comma separated list of Note fields to display. |
x_search_eligible_postsSearch for Posts Eligible for Community Notes
readx.x_search_eligible_posts| Parameter | Type | Required | Description |
|---|---|---|---|
test_mode | boolean | yes | If true, return a list of posts that are for the test. If false, return a list of posts that the bots can write proposed notes on the product. |
pagination_token | string | no | Pagination token to get next set of posts eligible for notes. |
max_results | integer | no | Max results to return. |
post_selection | string | no | The selection of posts to return. Valid values are 'feed_size: [small|large|xl|xxl], feed_lang: [en|es|...|all]'. Default (if not specified) is 'feed_size: small, feed_lang: en'. Only top AI writers have access to large, xl, and xxl size feeds. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_delete_community_notesDelete a Community Note
writex.x_delete_community_notes| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The community note id to delete. |
x_get_open_api_specGet OpenAPI Spec.
readx.x_get_open_api_spec| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
x_get_spaces_by_idsGet Spaces by IDs
readx.x_get_spaces_by_ids| Parameter | Type | Required | Description |
|---|---|---|---|
ids | array | yes | The list of Space IDs to return. |
space.fields | array | no | A comma separated list of Space fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
user.fields | array | no | A comma separated list of User fields to display. |
topic.fields | array | no | A comma separated list of Topic fields to display. |
x_get_spaces_by_creator_idsGet Spaces by creator IDs
readx.x_get_spaces_by_creator_ids| Parameter | Type | Required | Description |
|---|---|---|---|
user_ids | array | yes | The IDs of Users to search through. |
space.fields | array | no | A comma separated list of Space fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
user.fields | array | no | A comma separated list of User fields to display. |
topic.fields | array | no | A comma separated list of Topic fields to display. |
x_search_spacesSearch Spaces
readx.x_search_spaces| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | yes | The search query. |
state | string | no | The state of Spaces to search for. |
max_results | integer | no | The number of results to return. |
space.fields | array | no | A comma separated list of Space fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
user.fields | array | no | A comma separated list of User fields to display. |
topic.fields | array | no | A comma separated list of Topic fields to display. |
x_get_spaces_by_idGet space by ID
readx.x_get_spaces_by_id| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the Space to be retrieved. |
space.fields | array | no | A comma separated list of Space fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
user.fields | array | no | A comma separated list of User fields to display. |
topic.fields | array | no | A comma separated list of Topic fields to display. |
x_get_spaces_buyersGet Space ticket buyers
readx.x_get_spaces_buyers| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the Space to be retrieved. |
pagination_token | string | no | This parameter is used to get a specified 'page' of results. |
max_results | integer | no | The maximum number of results. |
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_get_spaces_postsGet Space Posts
readx.x_get_spaces_posts| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the Space to be retrieved. |
max_results | integer | no | The number of Posts to fetch from the provided space. If not provided, the value will default to the maximum of 100. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_get_trends_by_woeidGet Trends by WOEID
readx.x_get_trends_by_woeid| Parameter | Type | Required | Description |
|---|---|---|---|
woeid | integer | yes | The WOEID of the place to lookup a trend for. |
max_trends | integer | no | The maximum number of results. |
trend.fields | array | no | A comma separated list of Trend fields to display. |
x_get_posts_by_idsGet Posts by IDs
readx.x_get_posts_by_ids| Parameter | Type | Required | Description |
|---|---|---|---|
ids | array | yes | A comma separated list of Post IDs. Up to 100 are allowed in a single request. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_create_postsCreate or Edit Post
writex.x_create_posts| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | yes | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_get_posts_analyticsGet Post analytics
readx.x_get_posts_analytics| Parameter | Type | Required | Description |
|---|---|---|---|
ids | array | yes | A comma separated list of Post IDs. Up to 100 are allowed in a single request. |
end_time | string | yes | YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the end of the time range. |
start_time | string | yes | YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the start of the time range. |
granularity | string | yes | The granularity for the search counts results. |
analytics.fields | array | no | A comma separated list of Analytics fields to display. |
x_stream_posts_complianceStream Posts compliance data
readx.x_stream_posts_compliance| Parameter | Type | Required | Description |
|---|---|---|---|
backfill_minutes | integer | no | The number of minutes of backfill requested. |
partition | integer | yes | The partition number. |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post Compliance events will be provided. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Post Compliance events will be provided. |
x_get_posts_counts_allGet count of all Posts
readx.x_get_posts_counts_all| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | yes | One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length. |
start_time | string | no | 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). |
end_time | string | no | 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). |
since_id | string | no | Returns results with a Post ID greater than (that is, more recent than) the specified ID. |
until_id | string | no | Returns results with a Post ID less than (that is, older than) the specified ID. |
next_token | string | no | 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. |
pagination_token | string | no | 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. |
granularity | string | no | The granularity for the search counts results. |
search_count.fields | array | no | A comma separated list of SearchCount fields to display. |
x_get_posts_counts_recentGet count of recent Posts
readx.x_get_posts_counts_recent| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | yes | One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length. |
start_time | string | no | 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). |
end_time | string | no | 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). |
since_id | string | no | Returns results with a Post ID greater than (that is, more recent than) the specified ID. |
until_id | string | no | Returns results with a Post ID less than (that is, older than) the specified ID. |
next_token | string | no | 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. |
pagination_token | string | no | 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. |
granularity | string | no | The granularity for the search counts results. |
search_count.fields | array | no | A comma separated list of SearchCount fields to display. |
x_stream_posts_firehoseStream all Posts
readx.x_stream_posts_firehose| Parameter | Type | Required | Description |
|---|---|---|---|
backfill_minutes | integer | no | The number of minutes of backfill requested. |
partition | integer | yes | The partition number. |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_stream_posts_firehose_enStream English Posts
readx.x_stream_posts_firehose_en| Parameter | Type | Required | Description |
|---|---|---|---|
backfill_minutes | integer | no | The number of minutes of backfill requested. |
partition | integer | yes | The partition number. |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_stream_posts_firehose_jaStream Japanese Posts
readx.x_stream_posts_firehose_ja| Parameter | Type | Required | Description |
|---|---|---|---|
backfill_minutes | integer | no | The number of minutes of backfill requested. |
partition | integer | yes | The partition number. |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_stream_posts_firehose_koStream Korean Posts
readx.x_stream_posts_firehose_ko| Parameter | Type | Required | Description |
|---|---|---|---|
backfill_minutes | integer | no | The number of minutes of backfill requested. |
partition | integer | yes | The partition number. |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_stream_posts_firehose_ptStream Portuguese Posts
readx.x_stream_posts_firehose_pt| Parameter | Type | Required | Description |
|---|---|---|---|
backfill_minutes | integer | no | The number of minutes of backfill requested. |
partition | integer | yes | The partition number. |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_stream_labels_complianceStream Post labels
readx.x_stream_labels_compliance| Parameter | Type | Required | Description |
|---|---|---|---|
backfill_minutes | integer | no | The number of minutes of backfill requested. |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post labels will be provided. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Post labels will be provided. |
x_stream_posts_sampleStream sampled Posts
readx.x_stream_posts_sample| Parameter | Type | Required | Description |
|---|---|---|---|
backfill_minutes | integer | no | The number of minutes of backfill requested. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_stream_posts_sample10Stream 10% sampled Posts
readx.x_stream_posts_sample10| Parameter | Type | Required | Description |
|---|---|---|---|
backfill_minutes | integer | no | The number of minutes of backfill requested. |
partition | integer | yes | The partition number. |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_search_posts_allSearch all Posts
readx.x_search_posts_all| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | yes | One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length. |
start_time | string | no | 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). |
end_time | string | no | 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). |
since_id | string | no | Returns results with a Post ID greater than (that is, more recent than) the specified ID. |
until_id | string | no | Returns results with a Post ID less than (that is, older than) the specified ID. |
max_results | integer | no | The maximum number of search results to be returned by a request. |
next_token | string | no | 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. |
pagination_token | string | no | 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. |
sort_order | string | no | This order in which to return results. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_search_posts_recentSearch recent Posts
readx.x_search_posts_recent| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | yes | One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length. |
start_time | string | no | 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). |
end_time | string | no | 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). |
since_id | string | no | Returns results with a Post ID greater than (that is, more recent than) the specified ID. |
until_id | string | no | Returns results with a Post ID less than (that is, older than) the specified ID. |
max_results | integer | no | The maximum number of search results to be returned by a request. |
next_token | string | no | 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. |
pagination_token | string | no | 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. |
sort_order | string | no | This order in which to return results. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_stream_postsStream filtered Posts
readx.x_stream_posts| Parameter | Type | Required | Description |
|---|---|---|---|
backfill_minutes | integer | no | The number of minutes of backfill requested. |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_get_rulesGet stream rules
readx.x_get_rules| Parameter | Type | Required | Description |
|---|---|---|---|
ids | array | no | A comma-separated list of Rule IDs. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This value is populated by passing the 'next_token' returned in a request to paginate through results. |
x_update_rulesUpdate stream rules
writex.x_update_rules| Parameter | Type | Required | Description |
|---|---|---|---|
dry_run | boolean | no | Dry Run can be used with both the add and delete action, with the expected result given, but without actually taking any action in the system (meaning the end state will always be as it was when the request was submitted). This is particularly useful to validate rule changes. |
delete_all | boolean | no | Delete All can be used to delete all of the rules associated this client app, it should be specified with no other parameters. Once deleted, rules cannot be recovered. |
body | object | yes | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_get_rule_countsGet stream rule counts
readx.x_get_rule_counts| Parameter | Type | Required | Description |
|---|---|---|---|
rules_count.fields | array | no | A comma separated list of RulesCount fields to display. |
x_get_webhooks_stream_linksGet stream links
readx.x_get_webhooks_stream_links| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
x_delete_webhooks_stream_linkDelete stream link
writex.x_delete_webhooks_stream_link| Parameter | Type | Required | Description |
|---|---|---|---|
webhook_id | string | yes | The webhook ID to link to your FilteredStream ruleset. |
x_create_webhooks_stream_linkCreate stream link
writex.x_create_webhooks_stream_link| Parameter | Type | Required | Description |
|---|---|---|---|
webhook_id | string | yes | The webhook ID to link to your FilteredStream ruleset. |
tweet.fields | string | no | A comma separated list of Tweet fields to display. |
expansions | string | no | A comma separated list of fields to expand. |
media.fields | string | no | A comma separated list of Media fields to display. |
poll.fields | string | no | A comma separated list of Poll fields to display. |
user.fields | string | no | A comma separated list of User fields to display. |
place.fields | string | no | A comma separated list of Place fields to display. |
x_delete_postsDelete Post
writex.x_delete_posts| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the Post to be deleted. |
x_get_posts_by_idGet Post by ID
readx.x_get_posts_by_id| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | A single Post ID. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_get_posts_liking_usersGet Liking Users
readx.x_get_posts_liking_users| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | A single Post ID. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get the next 'page' of results. |
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_get_posts_quoted_postsGet Quoted Posts
readx.x_get_posts_quoted_posts| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | A single Post ID. |
max_results | integer | no | The maximum number of results to be returned. |
pagination_token | string | no | This parameter is used to get a specified 'page' of results. |
exclude | array | no | The set of entities to exclude (e.g. 'replies' or 'retweets'). |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_get_posts_reposted_byGet Reposted by
readx.x_get_posts_reposted_by| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | A single Post ID. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get the next 'page' of results. |
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_get_posts_repostsGet Reposts
readx.x_get_posts_reposts| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | A single Post ID. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get the next 'page' of results. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_hide_posts_replyHide reply
writex.x_hide_posts_reply| Parameter | Type | Required | Description |
|---|---|---|---|
tweet_id | string | yes | The ID of the reply that you want to hide or unhide. |
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_get_usageGet usage
readx.x_get_usage| Parameter | Type | Required | Description |
|---|---|---|---|
days | integer | no | The number of days for which you need usage for. |
usage.fields | array | no | A comma separated list of Usage fields to display. |
x_get_users_by_idsGet Users by IDs
readx.x_get_users_by_ids| Parameter | Type | Required | Description |
|---|---|---|---|
ids | array | yes | A list of User IDs, comma-separated. You can specify up to 100 IDs. |
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_get_users_by_usernamesGet Users by usernames
readx.x_get_users_by_usernames| Parameter | Type | Required | Description |
|---|---|---|---|
usernames | array | yes | A list of usernames, comma-separated. |
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_get_users_by_usernameGet User by username
readx.x_get_users_by_username| Parameter | Type | Required | Description |
|---|---|---|---|
username | string | yes | A username. |
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_stream_users_complianceStream Users compliance data
readx.x_stream_users_compliance| Parameter | Type | Required | Description |
|---|---|---|---|
backfill_minutes | integer | no | The number of minutes of backfill requested. |
partition | integer | yes | The partition number. |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the User Compliance events will be provided. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the User Compliance events will be provided. |
x_get_users_meGet my User
readx.x_get_users_me| Parameter | Type | Required | Description |
|---|---|---|---|
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_get_trends_personalized_trendsGet personalized Trends
readx.x_get_trends_personalized_trends| Parameter | Type | Required | Description |
|---|---|---|---|
personalized_trend.fields | array | no | A comma separated list of PersonalizedTrend fields to display. |
x_get_users_public_keysGet public keys for multiple users
readx.x_get_users_public_keys| Parameter | Type | Required | Description |
|---|---|---|---|
ids | array | yes | A list of User IDs, comma-separated. You can specify up to 100 IDs. |
public_key.fields | array | no | A comma separated list of PublicKey fields to display. |
x_get_users_reposts_of_meGet Reposts of me
readx.x_get_users_reposts_of_me| Parameter | Type | Required | Description |
|---|---|---|---|
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get the next 'page' of results. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_search_usersSearch Users
readx.x_search_users| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | yes | TThe the query string by which to query for users. |
max_results | integer | no | The maximum number of results. |
next_token | string | no | 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. |
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_get_users_by_idGet User by ID
readx.x_get_users_by_id| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the User to lookup. |
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_get_users_affiliatesGet affiliates
readx.x_get_users_affiliates| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the User to lookup. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get a specified 'page' of results. |
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_get_users_blockingGet blocking
readx.x_get_users_blocking| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User for whom to return results. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get a specified 'page' of results. |
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_get_users_bookmarksGet Bookmarks
readx.x_get_users_bookmarks| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User for whom to return results. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get the next 'page' of results. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_create_users_bookmarkCreate Bookmark
writex.x_create_users_bookmark| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User for whom to add bookmarks. |
body | object | yes | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_get_users_bookmark_foldersGet Bookmark folders
readx.x_get_users_bookmark_folders| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User for whom to return results. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get the next 'page' of results. |
x_get_users_bookmarks_by_folder_idGet Bookmarks by folder ID
readx.x_get_users_bookmarks_by_folder_id| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User for whom to return results. |
folder_id | string | yes | The ID of the Bookmark Folder that the authenticated User is trying to fetch Posts for. |
x_delete_users_bookmarkDelete Bookmark
writex.x_delete_users_bookmark| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User whose bookmark is to be removed. |
tweet_id | string | yes | The ID of the Post that the source User is removing from bookmarks. |
x_block_users_dmsBlock DMs
writex.x_block_users_dms| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the target User that the authenticated user requesting to block dms for. |
x_unblock_users_dmsUnblock DMs
writex.x_unblock_users_dms| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the target User that the authenticated user requesting to unblock dms for. |
x_get_users_followed_listsGet followed Lists
readx.x_get_users_followed_lists| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the User to lookup. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get a specified 'page' of results. |
list.fields | array | no | A comma separated list of List fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
user.fields | array | no | A comma separated list of User fields to display. |
x_follow_listFollow List
writex.x_follow_list| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User that will follow the List. |
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_unfollow_listUnfollow List
writex.x_unfollow_list| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User that will unfollow the List. |
list_id | string | yes | The ID of the List to unfollow. |
x_get_users_followersGet followers
readx.x_get_users_followers| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the User to lookup. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get a specified 'page' of results. |
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_get_users_followingGet following
readx.x_get_users_following| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the User to lookup. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get a specified 'page' of results. |
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_follow_userFollow User
writex.x_follow_user| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User that is requesting to follow the target User. |
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_get_users_liked_postsGet liked Posts
readx.x_get_users_liked_posts| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the User to lookup. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get the next 'page' of results. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_like_postLike Post
writex.x_like_post| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User that is requesting to like the Post. |
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_unlike_postUnlike Post
writex.x_unlike_post| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User that is requesting to unlike the Post. |
tweet_id | string | yes | The ID of the Post that the User is requesting to unlike. |
x_get_users_list_membershipsGet List memberships
readx.x_get_users_list_memberships| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the User to lookup. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get a specified 'page' of results. |
list.fields | array | no | A comma separated list of List fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
user.fields | array | no | A comma separated list of User fields to display. |
x_get_users_mentionsGet mentions
readx.x_get_users_mentions| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the User to lookup. |
since_id | string | no | The minimum Post ID to be included in the result set. This parameter takes precedence over start_time if both are specified. |
until_id | string | no | The maximum Post ID to be included in the result set. This parameter takes precedence over end_time if both are specified. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get the next 'page' of results. |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided. The since_id parameter takes precedence if it is also specified. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. The until_id parameter takes precedence if it is also specified. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_get_users_mutingGet muting
readx.x_get_users_muting| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User for whom to return results. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get the next 'page' of results. |
user.fields | array | no | A comma separated list of User fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
x_mute_userMute User
writex.x_mute_user| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User that is requesting to mute the target User. |
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_get_users_owned_listsGet owned Lists
readx.x_get_users_owned_lists| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the User to lookup. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get a specified 'page' of results. |
list.fields | array | no | A comma separated list of List fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
user.fields | array | no | A comma separated list of User fields to display. |
x_get_users_pinned_listsGet pinned Lists
readx.x_get_users_pinned_lists| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User for whom to return results. |
list.fields | array | no | A comma separated list of List fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
user.fields | array | no | A comma separated list of User fields to display. |
x_pin_listPin List
writex.x_pin_list| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User that will pin the List. |
body | object | yes | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_unpin_listUnpin List
writex.x_unpin_list| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User for whom to return results. |
list_id | string | yes | The ID of the List to unpin. |
x_get_users_public_keyGet user public keys
readx.x_get_users_public_key| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the User to lookup. |
public_key.fields | array | no | A comma separated list of PublicKey fields to display. |
x_add_user_public_keyAdd public key
writex.x_add_user_public_key| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the requesting user. |
body | object | yes | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_repost_postRepost Post
writex.x_repost_post| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User that is requesting to repost the Post. |
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_unrepost_postUnrepost Post
writex.x_unrepost_post| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User that is requesting to repost the Post. |
source_tweet_id | string | yes | The ID of the Post that the User is requesting to unretweet. |
x_get_users_timelineGet Timeline
readx.x_get_users_timeline| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the authenticated source User to list Reverse Chronological Timeline Posts of. |
since_id | string | no | The minimum Post ID to be included in the result set. This parameter takes precedence over start_time if both are specified. |
until_id | string | no | The maximum Post ID to be included in the result set. This parameter takes precedence over end_time if both are specified. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get the next 'page' of results. |
exclude | array | no | The set of entities to exclude (e.g. 'replies' or 'retweets'). |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided. The since_id parameter takes precedence if it is also specified. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. The until_id parameter takes precedence if it is also specified. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_get_users_postsGet Posts
readx.x_get_users_posts| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the User to lookup. |
since_id | string | no | The minimum Post ID to be included in the result set. This parameter takes precedence over start_time if both are specified. |
until_id | string | no | The maximum Post ID to be included in the result set. This parameter takes precedence over end_time if both are specified. |
max_results | integer | no | The maximum number of results. |
pagination_token | string | no | This parameter is used to get the next 'page' of results. |
exclude | array | no | The set of entities to exclude (e.g. 'replies' or 'retweets'). |
start_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided. The since_id parameter takes precedence if it is also specified. |
end_time | string | no | YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. The until_id parameter takes precedence if it is also specified. |
tweet.fields | array | no | A comma separated list of Tweet fields to display. |
expansions | array | no | A comma separated list of fields to expand. |
media.fields | array | no | A comma separated list of Media fields to display. |
poll.fields | array | no | A comma separated list of Poll fields to display. |
user.fields | array | no | A comma separated list of User fields to display. |
place.fields | array | no | A comma separated list of Place fields to display. |
x_unfollow_userUnfollow User
writex.x_unfollow_user| Parameter | Type | Required | Description |
|---|---|---|---|
source_user_id | string | yes | The ID of the authenticated source User that is requesting to unfollow the target User. |
target_user_id | string | yes | The ID of the User that the source User is requesting to unfollow. |
x_unmute_userUnmute User
writex.x_unmute_user| Parameter | Type | Required | Description |
|---|---|---|---|
source_user_id | string | yes | The ID of the authenticated source User that is requesting to unmute the target User. |
target_user_id | string | yes | The ID of the User that the source User is requesting to unmute. |
x_get_webhooksGet webhook
readx.x_get_webhooks| Parameter | Type | Required | Description |
|---|---|---|---|
webhook_config.fields | array | no | A comma separated list of WebhookConfig fields to display. |
x_create_webhooksCreate webhook
writex.x_create_webhooks| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_create_webhook_replay_jobCreate replay job for webhook
writex.x_create_webhook_replay_job| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | no | Request body for this X API operation. Use the shape documented by the official operation schema. |
x_delete_webhooksDelete webhook
writex.x_delete_webhooks| Parameter | Type | Required | Description |
|---|---|---|---|
webhook_id | string | yes | The ID of the webhook to delete. |
x_validate_webhooksValidate webhook
writex.x_validate_webhooks| Parameter | Type | Required | Description |
|---|---|---|---|
webhook_id | string | yes | The ID of the webhook to check. |