simple-x-api

Returns the authenticated user's X Developer Platform account. A user without an account gets a resource-not-found error entry.

Creates an X Developer Platform account for the authenticated user if they do not already have one, and returns it. Idempotent: when the user already has an account it is returned unchanged with `created` false.

Creates an Account Activity subscription for the user and the given webhook.

Deletes an Account Activity subscription for the given webhook and user ID.

Stream of X Activities

Get a list of active subscriptions for XAA

Creates a subscription for an X activity event. OAuth2 user-context tokens must hold the scope matching the requested event_type: dm.read for chat.* and dm.* events, like.read for like.* events, mute.read for mute.* events, block.read for block.* events, follows.read for subscriptions.* events, and tweet.read for all other event types. Mute and block subscriptions are actor-only: filter.user_id must identify the authenticated user and direction is not supported. subscriptions.* events require a user-context token and filter.user_id must identify the authenticated user. Optional filter.qualifiers further narrow supported chat, follow, unfollow, like, and subscriptions events.

Deletes multiple subscriptions for X activity events by their IDs

Updates a subscription for an X activity event

Deletes a subscription for an X activity event

Creates a new Article draft that can later be published.

Publishes a draft Article, making it publicly visible.

Creates a bot account in the calling app's project and returns its bearer token. Idempotent on handle: repeating the request for a handle that already names one of the project's bots returns that bot with a freshly minted token, revoking the previous one — safe to retry when a response was lost, since the replaced token was never seen.

Returns the authenticated user's live-video broadcasts, or selected owned broadcasts when ids are provided. At most one of `ids`, `max_results` may be provided. At most one of `ids`, `pagination_token` may be provided.

Returns the authenticated broadcaster's persistent moderators as User resources. The list applies to all of their current and future broadcast chats.

Adds a moderator to the authenticated broadcaster's persistent list and returns the updated moderator user IDs. The list applies to all current and future broadcast chats.

Removes a moderator from the authenticated broadcaster's persistent list and returns the updated moderator user IDs.

Returns scheduled broadcasts owned by the authenticated user.

Schedules a one-off or recurring broadcast for the authenticated user. A `source_id` (ingest) is required at create time.

Returns a single scheduled broadcast by its alphanumeric UBS broadcast id.

Fully replaces schedule fields for a broadcast. Path `:id` is the UBS broadcast id; the body must include `scheduled_broadcast_id` and re-send any fields that should be kept.

Deletes a scheduled broadcast by its alphanumeric UBS broadcast id.

Publishes a schedule that was created or updated with `manual_publish: true`. Without that flag the coordinator auto-publishes at start and this call is rejected.

Returns a broadcast owned by the authenticated user.

Returns newest-first chat messages for a broadcast owned by the authenticated user.

Posts a chat message to a running broadcast, attributed to the authenticated user.

Prevents a user from posting further messages in a running broadcast chat. When `end_at_ms` is provided, the mute expires at that time. The authenticated user must be the broadcast host or a moderator.

Allows a muted user to post messages in a running broadcast chat again. The authenticated user must be the broadcast host or a moderator.

Removes a specific chat message from a running broadcast where the authenticated user is the host or a moderator.

Retrieves a list of Chat conversations for the authenticated user's inbox.

Creates a new encrypted Chat group conversation on behalf of the authenticated user.

Initializes a new Chat group conversation and returns a unique conversation ID. Use the returned conversation_id in a subsequent POST /chat/conversations/group call to fully create and configure the group.

Returns metadata for a Chat conversation including type, muted status, and group details. Use chat_conversation.fields to select which fields are returned. Use expansions to hydrate member, admin, or participant user objects. Use user.fields to control which profile fields are returned for expanded users.

Retrieves messages and key change events for a specific Chat conversation with pagination support. For 1:1 conversations, provide the recipient's user ID; the server constructs the canonical conversation ID from the authenticated user and recipient.

Adds (initializes or rotates) the encryption keys for a Chat conversation. Call this before sending messages in a new 1:1 conversation, and again with a newer key version to rotate the conversation key. For 1:1 conversations, provide the recipient's user ID as the conversation id; the server constructs the canonical conversation ID from the authenticated user and recipient. The request body must contain the conversation key version and participant keys (the conversation key encrypted for each participant using their public key).

Adds one or more members to an existing encrypted Chat group conversation, rotating the conversation key.

Sends an encrypted message to a specific Chat conversation. For 1:1 conversations, provide the recipient's user ID; the server constructs the canonical conversation ID from the authenticated user and recipient. A recipient who cannot be messaged (closed inbox, system/notification account, or a 1:1 block) returns HTTP 403 with type https://api.x.com/2/problems/recipient-not-messageable.

Deletes one or more messages from a Chat conversation. For 1:1 conversations, provide the recipient's user ID; the server constructs the canonical conversation ID from the authenticated user and recipient. Delete for all removes a message you sent (or, in groups you administer, any message) for every participant; delete for self removes any message only from your own view.

Marks a specific Chat conversation as read on behalf of the authenticated user. For 1:1 conversations, provide the recipient's user ID; the server constructs the canonical conversation ID from the authenticated user and recipient.

Sends a typing indicator to a specific Chat conversation on behalf of the authenticated user. For 1:1 conversations, provide the recipient's user ID; the server constructs the canonical conversation ID from the authenticated user and recipient.

Initializes an XChat media upload session.

Appends media data to an XChat upload session.

Finalizes an XChat media upload session.

Downloads encrypted media bytes from an XChat conversation. The response body contains raw binary bytes.

Retrieves a list of Compliance Jobs filtered by job type and optional status.

Creates a new Compliance Job for the specified job type.

Retrieves details of a specific Compliance Job by its ID.

Cancels a Compliance Job that has not finished processing; its status becomes failed and a new job of the same type can be created.

Downloads the results file of a completed Compliance Job using the signed URL returned at job creation.

Uploads the newline-delimited ID file for a Compliance Job using the signed URL returned at job creation.

Returns active and historical streaming connections with disconnect reasons for the authenticated application.

Terminates multiple streaming connections by their UUIDs for the authenticated application.

Terminates all active streaming connections for the authenticated application.

Terminates all streaming connections for a specific endpoint ID for the authenticated application.

Initiates a new direct message conversation with specified participants.

Downloads media attached to a legacy Direct Message. The requesting user must be a participant in the conversation containing the specified DM event. The response body contains raw binary bytes.

Sends a new direct message to a specific participant by their ID.

Deletes a specific direct message event by its ID, if owned by the authenticated user.

Streams all compliance data related to Likes for Users.

Streams all public Likes in real-time.

Streams a 10% sample of public Likes in real-time.

Updates the details of a specific List owned by the authenticated user by its ID.

Deletes a specific List owned by the authenticated user by its ID.

Removes a User from a List by their ID.

Creates metadata for a Media file.

Creates subtitles for a specific Media file.

Deletes subtitles for a specific Media file.

Retrieves the status of a Media upload by its ID.

Uploads a media file for use in posts, direct messages, or ads. The response carries the media identifiers, including the media_key used to reference the asset in later calls. The media field carries the file content base64-encoded in JSON bodies (raw bytes in multipart bodies); media_category is tweet_image, tweet_video, or tweet_gif for posts and ads, dm_image/dm_video/dm_gif for DMs, or subtitles. For X Ads accounts, register the returned media_key via create_media_library_item to add it to the account's media library and use it in campaigns.

Initializes a media upload.

Finalizes a Media upload request.

Retrieves news story by its ID.

Deletes a community note.

Retrieves the full OpenAPI Specification in JSON format. (See https://github.com/OAI/OpenAPI-Specification/blob/master/README.md)

Retrieves a list of Spaces matching the specified search query.

Retrieves a list of Users who purchased tickets to a specific Space by its ID.

Retrieves a list of Posts shared in a specific Space by its ID.

Streams all compliance data related to Posts.

At most one of `pagination_token`, `next_token` may be provided.

At most one of `pagination_token`, `next_token` may be provided.

Streams all public Posts in real-time.

Streams all public English-language Posts in real-time.

Streams all public Japanese-language Posts in real-time.

Streams all public Korean-language Posts in real-time.

Streams all public Portuguese-language Posts in real-time.

Streams all labeling events applied to Posts.

Streams a 1% sample of public Posts in real-time.

Streams a 10% sample of public Posts in real-time.

At most one of `start_time`, `since_id` may be provided. At most one of `end_time`, `until_id` may be provided. At most one of `pagination_token`, `next_token` may be provided.

At most one of `start_time`, `since_id` may be provided. At most one of `end_time`, `until_id` may be provided. At most one of `pagination_token`, `next_token` may be provided.

Streams Posts in real-time matching the active rule set.

Returns the active filtered-stream rules for the authenticated app. Provide `ids` to fetch specific rules; omit it to list all rules.

Adds or deletes rules from the active rule set for the filtered stream. Exactly one of `add`, `delete`, or `?delete_all=true` must be specified. Use `?dry_run=true` to validate without committing.

Get a list of webhook links associated with a filtered stream ruleset.

Creates a link to deliver FilteredStream events to the given webhook.

Deletes the link delivering FilteredStream events to the given webhook.

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

Returns the payer's developer-platform credit balance in USD. total_balance is max(0, prepaid_balance + free_balance); prepaid_balance may be negative.

Streams all compliance data related to Users.

Returns registered public keys for X Chat encryption for the specified users.

Adds one or more Posts to the authenticated user's Bookmarks. Supply `tweet_id` for a single Post, or `tweet_ids` (at most 25) to bookmark several in one request. Optional `folder_id` applies to every Post in the request. Billing and rate limits still apply per HTTP request.

Creates a new Bookmark folder for the authenticated user.

Removes a Post from the authenticated user's Bookmarks by its ID.

Causes the authenticated user to unfollow a List by its ID.

When both are provided, `start_time` must be earlier than `end_time`. When both are provided, `since_id` must be less than `until_id`.

Causes the authenticated user to pin a specific List by its ID.

Causes the authenticated user to unpin a List by its ID.

Returns a user's registered public keys for X Chat encryption.

Registers a user's public key for X Chat encryption.

Causes the authenticated user to repost a specific Post by its ID.

Causes the authenticated user to unrepost a specific Post by its ID.

When both are provided, `start_time` must be earlier than `end_time`. When both are provided, `since_id` must be less than `until_id`.

When both are provided, `start_time` must be earlier than `end_time`. When both are provided, `since_id` must be less than `until_id`.

Causes the source User to unblock the target User.

Causes the authenticated user to unfollow a specific user by their ID.

Causes the authenticated user to unmute the target user.

Get a list of webhook configs associated with a client app.

Creates a new webhook configuration.

Creates a replay job to retrieve events from up to the past 24 hours for all events delivered or attempted to be delivered to the webhook.

Triggers a CRC check for a given webhook.

Deletes an existing webhook configuration.