KosmoKrator

social

Twitter / X Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Twitter / X KosmoKrator integration.

162 functions 96 read 66 write multi auth auth

Lua Namespace

Agents call this integration through app.integrations.x.*. Use lua_read_doc("integrations.x") inside KosmoKrator to discover the same reference at runtime.

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

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

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({})
Raw agent markdown
# 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({})
```

Metadata-Derived Lua Example

local result = app.integrations.x.x_get_account_activity_subscription_count({})
print(result)

Functions

x_get_account_activity_subscription_count

Get subscription count

Operation
Read read
Full name
x.x_get_account_activity_subscription_count
ParameterTypeRequiredDescription
No parameters.

x_validate_account_activity_subscription

Validate subscription

Operation
Read read
Full name
x.x_validate_account_activity_subscription
ParameterTypeRequiredDescription
webhook_id string yes The webhook ID to check subscription against.

x_create_account_activity_subscription

Create subscription

Operation
Write write
Full name
x.x_create_account_activity_subscription
ParameterTypeRequiredDescription
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_subscriptions

Get subscriptions

Operation
Read read
Full name
x.x_get_account_activity_subscriptions
ParameterTypeRequiredDescription
webhook_id string yes The webhook ID to pull subscriptions for.

x_delete_account_activity_subscription

Delete subscription

Operation
Write write
Full name
x.x_delete_account_activity_subscription
ParameterTypeRequiredDescription
webhook_id string yes The webhook ID to check subscription against.
user_id string yes User ID to unsubscribe from.

x_activity_stream

Activity Stream

Operation
Read read
Full name
x.x_activity_stream
ParameterTypeRequiredDescription
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_ids

Delete X activity subscriptions by IDs

Operation
Write write
Full name
x.x_delete_activity_subscriptions_by_ids
ParameterTypeRequiredDescription
ids array yes Comma-separated list of subscription IDs to delete.

x_get_activity_subscriptions

Get X activity subscriptions

Operation
Read read
Full name
x.x_get_activity_subscriptions
ParameterTypeRequiredDescription
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_subscription

Create X activity subscription

Operation
Write write
Full name
x.x_create_activity_subscription
ParameterTypeRequiredDescription
body object no Request body for this X API operation. Use the shape documented by the official operation schema.

x_delete_activity_subscription

Deletes X activity subscription

Operation
Write write
Full name
x.x_delete_activity_subscription
ParameterTypeRequiredDescription
subscription_id string yes The ID of the subscription to delete.

x_update_activity_subscription

Update X activity subscription

Operation
Write write
Full name
x.x_update_activity_subscription
ParameterTypeRequiredDescription
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_conversations

Get Chat Conversations

Operation
Read read
Full name
x.x_get_chat_conversations
ParameterTypeRequiredDescription
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_conversation

Create Chat Group Conversation

Operation
Write write
Full name
x.x_create_chat_conversation
ParameterTypeRequiredDescription
body object yes Request body for this X API operation. Use the shape documented by the official operation schema.

x_initialize_chat_group

Initialize Chat Group

Operation
Write write
Full name
x.x_initialize_chat_group
ParameterTypeRequiredDescription
No parameters.

x_get_chat_conversation

Get Chat Conversation

Operation
Read read
Full name
x.x_get_chat_conversation
ParameterTypeRequiredDescription
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_keys

Initialize Conversation Keys

Operation
Write write
Full name
x.x_initialize_chat_conversation_keys
ParameterTypeRequiredDescription
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_members

Add members to a Chat group conversation

Operation
Write write
Full name
x.x_add_chat_group_members
ParameterTypeRequiredDescription
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_message

Send Chat Message

Operation
Write write
Full name
x.x_send_chat_message
ParameterTypeRequiredDescription
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_read

Mark Conversation as Read

Operation
Write write
Full name
x.x_mark_chat_conversation_read
ParameterTypeRequiredDescription
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_indicator

Send Typing Indicator

Operation
Write write
Full name
x.x_send_chat_typing_indicator
ParameterTypeRequiredDescription
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_initialize

Initialize Chat Media Upload

Operation
Write write
Full name
x.x_chat_media_upload_initialize
ParameterTypeRequiredDescription
body object yes Request body for this X API operation. Use the shape documented by the official operation schema.

x_chat_media_upload_append

Append Chat Media Upload

Operation
Write write
Full name
x.x_chat_media_upload_append
ParameterTypeRequiredDescription
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_finalize

Finalize Chat Media Upload

Operation
Write write
Full name
x.x_chat_media_upload_finalize
ParameterTypeRequiredDescription
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_download

Download Chat Media

Operation
Read read
Full name
x.x_chat_media_download
ParameterTypeRequiredDescription
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_communities

Search Communities

Operation
Read read
Full name
x.x_search_communities
ParameterTypeRequiredDescription
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_id

Get Community by ID

Operation
Read read
Full name
x.x_get_communities_by_id
ParameterTypeRequiredDescription
id string yes The ID of the Community.
community.fields array no A comma separated list of Community fields to display.

x_get_compliance_jobs

Get Compliance Jobs

Operation
Read read
Full name
x.x_get_compliance_jobs
ParameterTypeRequiredDescription
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_jobs

Create Compliance Job

Operation
Write write
Full name
x.x_create_compliance_jobs
ParameterTypeRequiredDescription
body object yes Request body for this X API operation. Use the shape documented by the official operation schema.

x_get_compliance_jobs_by_id

Get Compliance Job by ID

Operation
Read read
Full name
x.x_get_compliance_jobs_by_id
ParameterTypeRequiredDescription
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_uuids

Terminate multiple connections

Operation
Write write
Full name
x.x_delete_connections_by_uuids
ParameterTypeRequiredDescription
body object yes Request body for this X API operation. Use the shape documented by the official operation schema.

x_get_connection_history

Get Connection History

Operation
Read read
Full name
x.x_get_connection_history
ParameterTypeRequiredDescription
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_connections

Terminate all connections

Operation
Write write
Full name
x.x_delete_all_connections
ParameterTypeRequiredDescription
No parameters.

x_delete_connections_by_endpoint

Terminate connections by endpoint

Operation
Write write
Full name
x.x_delete_connections_by_endpoint
ParameterTypeRequiredDescription
endpoint_id string yes The endpoint ID to terminate connections for.

x_create_direct_messages_conversation

Create DM conversation

Operation
Write write
Full name
x.x_create_direct_messages_conversation
ParameterTypeRequiredDescription
body object no Request body for this X API operation. Use the shape documented by the official operation schema.

x_dm_conversations_media_download

Download DM Media

Operation
Read read
Full name
x.x_dm_conversations_media_download
ParameterTypeRequiredDescription
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_id

Get DM events for a DM conversation

Operation
Read read
Full name
x.x_get_direct_messages_events_by_participant_id
ParameterTypeRequiredDescription
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_id

Create DM message by participant ID

Operation
Write write
Full name
x.x_create_direct_messages_by_participant_id
ParameterTypeRequiredDescription
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_id

Create DM message by conversation ID

Operation
Write write
Full name
x.x_create_direct_messages_by_conversation_id
ParameterTypeRequiredDescription
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_id

Get DM events for a DM conversation

Operation
Read read
Full name
x.x_get_direct_messages_events_by_conversation_id
ParameterTypeRequiredDescription
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_events

Get DM events

Operation
Read read
Full name
x.x_get_direct_messages_events
ParameterTypeRequiredDescription
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_events

Delete DM event

Operation
Write write
Full name
x.x_delete_direct_messages_events
ParameterTypeRequiredDescription
event_id string yes The ID of the direct-message event to delete.

x_get_direct_messages_events_by_id

Get DM event by ID

Operation
Read read
Full name
x.x_get_direct_messages_events_by_id
ParameterTypeRequiredDescription
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_notes

Evaluate a Community Note

Operation
Write write
Full name
x.x_evaluate_community_notes
ParameterTypeRequiredDescription
body object no Request body for this X API operation. Use the shape documented by the official operation schema.

x_get_insights28_hr

Get 28-hour Post insights

Operation
Read read
Full name
x.x_get_insights28_hr
ParameterTypeRequiredDescription
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_historical

Get historical Post insights

Operation
Read read
Full name
x.x_get_insights_historical
ParameterTypeRequiredDescription
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_compliance

Stream Likes compliance data

Operation
Read read
Full name
x.x_stream_likes_compliance
ParameterTypeRequiredDescription
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_firehose

Stream all Likes

Operation
Read read
Full name
x.x_stream_likes_firehose
ParameterTypeRequiredDescription
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_sample10

Stream sampled Likes

Operation
Read read
Full name
x.x_stream_likes_sample10
ParameterTypeRequiredDescription
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_lists

Create List

Operation
Write write
Full name
x.x_create_lists
ParameterTypeRequiredDescription
body object no Request body for this X API operation. Use the shape documented by the official operation schema.

x_delete_lists

Delete List

Operation
Write write
Full name
x.x_delete_lists
ParameterTypeRequiredDescription
id string yes The ID of the List to delete.

x_get_lists_by_id

Get List by ID

Operation
Read read
Full name
x.x_get_lists_by_id
ParameterTypeRequiredDescription
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_lists

Update List

Operation
Write write
Full name
x.x_update_lists
ParameterTypeRequiredDescription
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_followers

Get List followers

Operation
Read read
Full name
x.x_get_lists_followers
ParameterTypeRequiredDescription
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_members

Get List members

Operation
Read read
Full name
x.x_get_lists_members
ParameterTypeRequiredDescription
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_member

Add List member

Operation
Write write
Full name
x.x_add_lists_member
ParameterTypeRequiredDescription
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_id

Remove List member

Operation
Write write
Full name
x.x_remove_lists_member_by_user_id
ParameterTypeRequiredDescription
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_posts

Get List Posts

Operation
Read read
Full name
x.x_get_lists_posts
ParameterTypeRequiredDescription
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_keys

Get Media by media keys

Operation
Read read
Full name
x.x_get_media_by_media_keys
ParameterTypeRequiredDescription
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_analytics

Get Media analytics

Operation
Read read
Full name
x.x_get_media_analytics
ParameterTypeRequiredDescription
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_metadata

Create Media metadata

Operation
Write write
Full name
x.x_create_media_metadata
ParameterTypeRequiredDescription
body object no Request body for this X API operation. Use the shape documented by the official operation schema.

x_delete_media_subtitles

Delete Media subtitles

Operation
Write write
Full name
x.x_delete_media_subtitles
ParameterTypeRequiredDescription
body object no Request body for this X API operation. Use the shape documented by the official operation schema.

x_create_media_subtitles

Create Media subtitles

Operation
Write write
Full name
x.x_create_media_subtitles
ParameterTypeRequiredDescription
body object no Request body for this X API operation. Use the shape documented by the official operation schema.

x_get_media_upload_status

Get Media upload status

Operation
Read read
Full name
x.x_get_media_upload_status
ParameterTypeRequiredDescription
media_id string yes Media id for the requested media upload status.
command string no The command for the media upload request.

x_media_upload

Upload media

Operation
Write write
Full name
x.x_media_upload
ParameterTypeRequiredDescription
body object no Request body for this X API operation. Use the shape documented by the official operation schema.

x_initialize_media_upload

Initialize media upload

Operation
Write write
Full name
x.x_initialize_media_upload
ParameterTypeRequiredDescription
body object no Request body for this X API operation. Use the shape documented by the official operation schema.

x_append_media_upload

Append Media upload

Operation
Write write
Full name
x.x_append_media_upload
ParameterTypeRequiredDescription
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_upload

Finalize Media upload

Operation
Write write
Full name
x.x_finalize_media_upload
ParameterTypeRequiredDescription
id string yes The media id of the targeted media to finalize.

x_get_media_by_media_key

Get Media by media key

Operation
Read read
Full name
x.x_get_media_by_media_key
ParameterTypeRequiredDescription
media_key string yes A single Media Key.
media.fields array no A comma separated list of Media fields to display.

x_search_news

Search News

Operation
Read read
Full name
x.x_search_news
ParameterTypeRequiredDescription
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_news

Get news stories by ID

Operation
Read read
Full name
x.x_get_news
ParameterTypeRequiredDescription
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_notes

Create a Community Note

Operation
Write write
Full name
x.x_create_community_notes
ParameterTypeRequiredDescription
body object no Request body for this X API operation. Use the shape documented by the official operation schema.

x_search_community_notes_written

Search for Community Notes Written

Operation
Read read
Full name
x.x_search_community_notes_written
ParameterTypeRequiredDescription
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_posts

Search for Posts Eligible for Community Notes

Operation
Read read
Full name
x.x_search_eligible_posts
ParameterTypeRequiredDescription
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_notes

Delete a Community Note

Operation
Write write
Full name
x.x_delete_community_notes
ParameterTypeRequiredDescription
id string yes The community note id to delete.

x_get_open_api_spec

Get OpenAPI Spec.

Operation
Read read
Full name
x.x_get_open_api_spec
ParameterTypeRequiredDescription
No parameters.

x_get_spaces_by_ids

Get Spaces by IDs

Operation
Read read
Full name
x.x_get_spaces_by_ids
ParameterTypeRequiredDescription
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_ids

Get Spaces by creator IDs

Operation
Read read
Full name
x.x_get_spaces_by_creator_ids
ParameterTypeRequiredDescription
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_spaces

Search Spaces

Operation
Read read
Full name
x.x_search_spaces
ParameterTypeRequiredDescription
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_id

Get space by ID

Operation
Read read
Full name
x.x_get_spaces_by_id
ParameterTypeRequiredDescription
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_buyers

Get Space ticket buyers

Operation
Read read
Full name
x.x_get_spaces_buyers
ParameterTypeRequiredDescription
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_posts

Get Space Posts

Operation
Read read
Full name
x.x_get_spaces_posts
ParameterTypeRequiredDescription
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_posts_by_ids

Get Posts by IDs

Operation
Read read
Full name
x.x_get_posts_by_ids
ParameterTypeRequiredDescription
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_posts

Create or Edit Post

Operation
Write write
Full name
x.x_create_posts
ParameterTypeRequiredDescription
body object yes Request body for this X API operation. Use the shape documented by the official operation schema.

x_get_posts_analytics

Get Post analytics

Operation
Read read
Full name
x.x_get_posts_analytics
ParameterTypeRequiredDescription
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_compliance

Stream Posts compliance data

Operation
Read read
Full name
x.x_stream_posts_compliance
ParameterTypeRequiredDescription
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_all

Get count of all Posts

Operation
Read read
Full name
x.x_get_posts_counts_all
ParameterTypeRequiredDescription
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_recent

Get count of recent Posts

Operation
Read read
Full name
x.x_get_posts_counts_recent
ParameterTypeRequiredDescription
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_firehose

Stream all Posts

Operation
Read read
Full name
x.x_stream_posts_firehose
ParameterTypeRequiredDescription
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_en

Stream English Posts

Operation
Read read
Full name
x.x_stream_posts_firehose_en
ParameterTypeRequiredDescription
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_ja

Stream Japanese Posts

Operation
Read read
Full name
x.x_stream_posts_firehose_ja
ParameterTypeRequiredDescription
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_ko

Stream Korean Posts

Operation
Read read
Full name
x.x_stream_posts_firehose_ko
ParameterTypeRequiredDescription
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_pt

Stream Portuguese Posts

Operation
Read read
Full name
x.x_stream_posts_firehose_pt
ParameterTypeRequiredDescription
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_compliance

Stream Post labels

Operation
Read read
Full name
x.x_stream_labels_compliance
ParameterTypeRequiredDescription
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_sample

Stream sampled Posts

Operation
Read read
Full name
x.x_stream_posts_sample
ParameterTypeRequiredDescription
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_sample10

Stream 10% sampled Posts

Operation
Read read
Full name
x.x_stream_posts_sample10
ParameterTypeRequiredDescription
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_all

Search all Posts

Operation
Read read
Full name
x.x_search_posts_all
ParameterTypeRequiredDescription
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_recent

Search recent Posts

Operation
Read read
Full name
x.x_search_posts_recent
ParameterTypeRequiredDescription
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_posts

Stream filtered Posts

Operation
Read read
Full name
x.x_stream_posts
ParameterTypeRequiredDescription
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_rules

Get stream rules

Operation
Read read
Full name
x.x_get_rules
ParameterTypeRequiredDescription
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_rules

Update stream rules

Operation
Write write
Full name
x.x_update_rules
ParameterTypeRequiredDescription
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_counts

Get stream rule counts

Operation
Read read
Full name
x.x_get_rule_counts
ParameterTypeRequiredDescription
rules_count.fields array no A comma separated list of RulesCount fields to display.

x_delete_posts

Delete Post

Operation
Write write
Full name
x.x_delete_posts
ParameterTypeRequiredDescription
id string yes The ID of the Post to be deleted.

x_get_posts_by_id

Get Post by ID

Operation
Read read
Full name
x.x_get_posts_by_id
ParameterTypeRequiredDescription
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_users

Get Liking Users

Operation
Read read
Full name
x.x_get_posts_liking_users
ParameterTypeRequiredDescription
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_posts

Get Quoted Posts

Operation
Read read
Full name
x.x_get_posts_quoted_posts
ParameterTypeRequiredDescription
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_by

Get Reposted by

Operation
Read read
Full name
x.x_get_posts_reposted_by
ParameterTypeRequiredDescription
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_reposts

Get Reposts

Operation
Read read
Full name
x.x_get_posts_reposts
ParameterTypeRequiredDescription
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_reply

Hide reply

Operation
Write write
Full name
x.x_hide_posts_reply
ParameterTypeRequiredDescription
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_usage

Get usage

Operation
Read read
Full name
x.x_get_usage
ParameterTypeRequiredDescription
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_ids

Get Users by IDs

Operation
Read read
Full name
x.x_get_users_by_ids
ParameterTypeRequiredDescription
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_usernames

Get Users by usernames

Operation
Read read
Full name
x.x_get_users_by_usernames
ParameterTypeRequiredDescription
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_username

Get User by username

Operation
Read read
Full name
x.x_get_users_by_username
ParameterTypeRequiredDescription
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_compliance

Stream Users compliance data

Operation
Read read
Full name
x.x_stream_users_compliance
ParameterTypeRequiredDescription
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_me

Get my User

Operation
Read read
Full name
x.x_get_users_me
ParameterTypeRequiredDescription
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_public_keys

Get public keys for multiple users

Operation
Read read
Full name
x.x_get_users_public_keys
ParameterTypeRequiredDescription
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_me

Get Reposts of me

Operation
Read read
Full name
x.x_get_users_reposts_of_me
ParameterTypeRequiredDescription
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_users

Search Users

Operation
Read read
Full name
x.x_search_users
ParameterTypeRequiredDescription
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_id

Get User by ID

Operation
Read read
Full name
x.x_get_users_by_id
ParameterTypeRequiredDescription
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_affiliates

Get affiliates

Operation
Read read
Full name
x.x_get_users_affiliates
ParameterTypeRequiredDescription
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_blocking

Get blocking

Operation
Read read
Full name
x.x_get_users_blocking
ParameterTypeRequiredDescription
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_bookmarks

Get Bookmarks

Operation
Read read
Full name
x.x_get_users_bookmarks
ParameterTypeRequiredDescription
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_bookmark

Create Bookmark

Operation
Write write
Full name
x.x_create_users_bookmark
ParameterTypeRequiredDescription
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_folders

Get Bookmark folders

Operation
Read read
Full name
x.x_get_users_bookmark_folders
ParameterTypeRequiredDescription
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_id

Get Bookmarks by folder ID

Operation
Read read
Full name
x.x_get_users_bookmarks_by_folder_id
ParameterTypeRequiredDescription
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_bookmark

Delete Bookmark

Operation
Write write
Full name
x.x_delete_users_bookmark
ParameterTypeRequiredDescription
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_dms

Block DMs

Operation
Write write
Full name
x.x_block_users_dms
ParameterTypeRequiredDescription
id string yes The ID of the target User that the authenticated user requesting to block dms for.

x_unblock_users_dms

Unblock DMs

Operation
Write write
Full name
x.x_unblock_users_dms
ParameterTypeRequiredDescription
id string yes The ID of the target User that the authenticated user requesting to unblock dms for.

x_get_users_followed_lists

Get followed Lists

Operation
Read read
Full name
x.x_get_users_followed_lists
ParameterTypeRequiredDescription
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_list

Follow List

Operation
Write write
Full name
x.x_follow_list
ParameterTypeRequiredDescription
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_list

Unfollow List

Operation
Write write
Full name
x.x_unfollow_list
ParameterTypeRequiredDescription
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_followers

Get followers

Operation
Read read
Full name
x.x_get_users_followers
ParameterTypeRequiredDescription
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_following

Get following

Operation
Read read
Full name
x.x_get_users_following
ParameterTypeRequiredDescription
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_user

Follow User

Operation
Write write
Full name
x.x_follow_user
ParameterTypeRequiredDescription
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_posts

Get liked Posts

Operation
Read read
Full name
x.x_get_users_liked_posts
ParameterTypeRequiredDescription
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_post

Like Post

Operation
Write write
Full name
x.x_like_post
ParameterTypeRequiredDescription
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_post

Unlike Post

Operation
Write write
Full name
x.x_unlike_post
ParameterTypeRequiredDescription
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_memberships

Get List memberships

Operation
Read read
Full name
x.x_get_users_list_memberships
ParameterTypeRequiredDescription
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_mentions

Get mentions

Operation
Read read
Full name
x.x_get_users_mentions
ParameterTypeRequiredDescription
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_muting

Get muting

Operation
Read read
Full name
x.x_get_users_muting
ParameterTypeRequiredDescription
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_user

Mute User

Operation
Write write
Full name
x.x_mute_user
ParameterTypeRequiredDescription
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_lists

Get owned Lists

Operation
Read read
Full name
x.x_get_users_owned_lists
ParameterTypeRequiredDescription
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_lists

Get pinned Lists

Operation
Read read
Full name
x.x_get_users_pinned_lists
ParameterTypeRequiredDescription
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_list

Pin List

Operation
Write write
Full name
x.x_pin_list
ParameterTypeRequiredDescription
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_list

Unpin List

Operation
Write write
Full name
x.x_unpin_list
ParameterTypeRequiredDescription
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_key

Get user public keys

Operation
Read read
Full name
x.x_get_users_public_key
ParameterTypeRequiredDescription
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_key

Add public key

Operation
Write write
Full name
x.x_add_user_public_key
ParameterTypeRequiredDescription
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_post

Repost Post

Operation
Write write
Full name
x.x_repost_post
ParameterTypeRequiredDescription
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_post

Unrepost Post

Operation
Write write
Full name
x.x_unrepost_post
ParameterTypeRequiredDescription
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_timeline

Get Timeline

Operation
Read read
Full name
x.x_get_users_timeline
ParameterTypeRequiredDescription
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_posts

Get Posts

Operation
Read read
Full name
x.x_get_users_posts
ParameterTypeRequiredDescription
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_user

Unfollow User

Operation
Write write
Full name
x.x_unfollow_user
ParameterTypeRequiredDescription
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_user

Unmute User

Operation
Write write
Full name
x.x_unmute_user
ParameterTypeRequiredDescription
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_webhooks

Get webhook

Operation
Read read
Full name
x.x_get_webhooks
ParameterTypeRequiredDescription
webhook_config.fields array no A comma separated list of WebhookConfig fields to display.

x_create_webhooks

Create webhook

Operation
Write write
Full name
x.x_create_webhooks
ParameterTypeRequiredDescription
body object no Request body for this X API operation. Use the shape documented by the official operation schema.

x_create_webhook_replay_job

Create replay job for webhook

Operation
Write write
Full name
x.x_create_webhook_replay_job
ParameterTypeRequiredDescription
body object no Request body for this X API operation. Use the shape documented by the official operation schema.

x_delete_webhooks

Delete webhook

Operation
Write write
Full name
x.x_delete_webhooks
ParameterTypeRequiredDescription
webhook_id string yes The ID of the webhook to delete.

x_validate_webhooks

Validate webhook

Operation
Write write
Full name
x.x_validate_webhooks
ParameterTypeRequiredDescription
webhook_id string yes The ID of the webhook to check.