Xquik API
Xquik is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp. Read and automate X. Paid reads accept…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Xquik is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp. Read and automate X. Paid reads accept credits. Some lookups accept MPP. Writes require an API key or OAuth 2.1. Reads without your own X account return public data only.
What you get
Complete results
- Searches return posts that X's own search tab leaves out.
- Each answer holds the fullest data X has for it.
Accurate rows
- Reposts carry the full original text.
- Every ID in a row stays exact.
- Mentions, links, hashtags & highlights line up with the text.
- Verified badges match what x.com shows.
- Rows hold public data only.
- Ads & promoted entries never reach your rows.
Fresh data
- Reads keep working when X ships changes.
Speed
- A slow X answer doesn't hold up your request.
- Repeated lookups answer at once.
- Reads finish the moment their rows arrive.
Fair billing
- You pay only for the rows you get, after filters & duplicate removal.
- A retried page is free.
- A low balance trims results instead of failing.
Reliability
- A one-off X failure doesn't fail your request.
- Paging stays consistent from one page to the next.
- Paging never loops forever.
- A deadline returns the rows already found, with diagnostics.
- Problems on X's side are fixed before they reach your reads.
Built for agents
- Agents reach the whole API through a few MCP tools.
- Paid results are saved under a
result_id, so failed scripts never pay twice. - Large answers fit the agent's context, capped at 24,000 characters.
- A cut answer links to a CSV file of every row.
- Each MCP tool states its credit price.
- Clients can run reads without prompts & confirm writes.
- 1 stable shape with snake_case, Unix seconds,
has_more&next_cursor. REST calls get it withxquik-api-contract: 2026-04-29. - Sign-in works in modern MCP clients with OAuth 2.1 & PKCE.
whoamireturns an account ID that never changes.- Agents can pay per call without an account.
- Tool input errors say what to change.
- MCP shows why a post or search failed.
- Rate limits & deprecations come as machine-readable headers.
- Common names for cursor, limit, sort & type just work.
- Pause a runaway agent's API key in 1 click, then resume it anytime.
- Lock an API key to the IPs or CIDR ranges your servers call from.
- Cap what an API key spends each month, with an email at 80%.
Rich data
- Rows carry source apps, media counts & professional account data.
- Short links resolve, & list rows can carry full profiles.
- Community Notes contributors & notes, Space replays & job listings as Markdown.
Quality checks
- Every field X shows is served, left out on purpose or proven absent.
- Every read is checked live each hour.
- Xquik checks each API spec change against the docs before it ships.
Rate limits
Every authenticated response carries RateLimit-Policy, your limit for that kind of request, and RateLimit, your requests left & seconds until the window resets. A refused request gets 429 with Retry-After.
Credits charged
An answer to a read carries X-Xquik-Credits-Charged, the credits that request charged. It is 0 for a page a filter empties & for a page sent again. A write names its charge in its body's billing.
Deprecation
v1 stays compatible. A breaking removal gets at least 90 days of notice. A request with a deprecated query parameter or search filter gets an RFC 9745 Deprecation header. The answer's Link header points to the deprecation policy. Once a removal date is set, an RFC 8594 Sunset header gives that date. Each operation that sends these headers declares them on its success answer. The versioning guide lists today's deprecations.
Client libraries
Endpoints 224
API Keys
- GETlistApiKeys
/api/v1/api-keysReturns API key metadata without exposing secret key values. - POSTcreateApiKey
/api/v1/api-keysCreates a revocable API key and returns its secret once. - PATCHpauseApiKeys
/api/v1/api-keysPauses or resumes up to 100 of your API keys at once & lists the keys it changed, newest first. It skips revoked, expired, unknown & other accounts' keys.… - POSTbulkRevokeApiKeys
/api/v1/api-keys/bulk-revokeRevokes up to 100 of your API keys at once & lists the IDs it revoked, newest first. IDs of other accounts' keys or unknown keys are skipped. - DELETErevokeApiKey
/api/v1/api-keys/:idPermanently revokes the selected API key. - PATCHupdateApiKey
/api/v1/api-keys/:idRenames an active API key, changes its scopes, IP allowlist or monthly credit budget, or pauses or resumes it. Send any of name, scope, scopes, paused,…
Account
- GETgetAccount
/api/v1/accountReturns plan, credit, monitoring, and account settings for the authenticated user. - PATCHupdateAccount
/api/v1/accountChanges the locale used for account responses and notifications. - PUTsetXIdentity
/api/v1/account/x-identityLinks an X username to the authenticated Xquik account.
Activity
- GETlistActivity
/api/v1/activityReturns the account's activity log, newest first, with the Activity page's filters. It covers write actions, extractions, monitor changes and events,… - GETgetActivity
/api/v1/activity/:idReturns 1 activity of the account with its full technical record. It covers every kind of activity the Activity log shows. The record holds the request, the…
Agent Discovery
- GETsearchXquikDocumentationWithQuery
/ask?query=stringSend a flat NLWeb 0.55 request through query parameters. - POSTsearchXquikDocumentation
/askSearch public Xquik docs with NLWeb 0.55. This read-only route accepts flat and structured requests. Never send secrets or private data. - GETauthorizeOAuthClient
/api/oauth/authorize?response_type=code&client_id=string&code_challenge=string&code_challenge_method=S256Open this URL in the user's browser to start OAuth 2.1 sign-in with PKCE. The user signs in & approves access. Xquik then sends a code to your redirect_uri. - POSTcreateOAuthToken
/api/oauth/tokenExchange an authorization code, a refresh token, an agent claim token or an identity assertion for an access token. - POSTrevokeOAuthToken
/api/oauth/revokeRevoke an access token, a refresh token or a claimed agent's identity assertion. An unknown or already revoked token still returns 200. - POSTregisterOAuthClient
/api/oauth/registerRegister an OAuth client by Dynamic Client Registration. Clients with a client metadata document can skip this step. - POSTregisterAgentIdentity
/agent/identityRegister an agent for a user's verified email. The user claims it at claim.verification_uri with claim.user_code. Poll the token endpoint with claim_token… - POSTrefreshAgentIdentityClaim
/agent/identity/claimGet a new user code for a pending agent registration, such as after the last one expired. The claim token must still be valid.
Analysis
- POSTanalyzeTweetSentiment
/api/v1/x/analysis/sentimentAnswers each post's attitude, its intensity & its sarcasm probability. Sentiment analysis names each post's main emotion, such as joy or anger. Send post IDs,… - POSTanalyzeBrandMentions
/api/v1/x/analysis/brandAnswers whether each post is about your brand, the author's attitude toward it & the author's relationship with it. Name the brand in analysis.targets. Each… - POSTanalyzeNewsPosts
/api/v1/x/analysis/newsAnswers each post's format, such as reporting, commentary or speculation, its source attribution & its relevance to your topic. Name the topic in… - POSTanalyzeMarketSignals
/api/v1/x/analysis/market-signalsAnswers each post's stance on an asset, its content type, its conviction & its relevance. The summary counts bullish & bearish posts per cashtag. Name the… - POSTanalyzeTweetViralScore
/api/v1/x/analysis/viral-scoreAnswers each post's hook, clarity, payoff, humor, spam risk & likely reaction, & adds a Viral Score from 0 to 100 with a verdict. The score rates the wording.… - POSTclassifyTweets
/api/v1/x/analysis/classifyAnswers the questions you write in analysis.questions. A choice picks a category, such as a topic. A score picks a level. A probability answers yes or no.…
Articles
- GETgetArticle
/api/v1/x/articles/:tweetIdReturns the full content of an X Article (long-form post) by numeric tweet ID. Returns article_not_found when the tweet is valid but is not an X Article.
Broadcasts
- GETgetBroadcast
/api/v1/x/broadcasts/:idReturns 1 X broadcast, the live video X hosts at x.com/i/broadcasts, live or ended. Accepts the broadcast ID or the URL-encoded broadcast URL. Reading a…
Communities
- GETgetCommunityInfo
/api/v1/x/communities/:id/infoReturns 1 community's public identity, rules, join question, search tags, membership counts, and the profiles of its creator, admin and previewed members. - GETgetCommunityAnalytics
/api/v1/x/communities/:id/analyticsReturns community activity for X's latest period. Includes likes, new members, posts, replies & unique posters. Each metric has a count and a changePercent.… - GETgetCommunityMembers
/api/v1/x/communities/:id/membersReturns public member profiles for 1 community. - GETsearchCommunityMembers
/api/v1/x/communities/:id/members/search?q=stringFinds a community's members by name or username, each with its role. An answer holds up to 10 members. Each member costs 1 credit. An answer without members… - GETgetCommunityModerators
/api/v1/x/communities/:id/moderatorsReturns public moderator profiles for 1 community. - GETgetCommunityTweets
/api/v1/x/communities/:id/tweetsReturns public tweets posted within 1 community, newest first by default. Send queryType=Top for the posts X ranks highest. The first page opens with the… - GETgetCommunityMedia
/api/v1/x/communities/:id/mediaReturns the tweets with photos or videos on 1 community's Media tab, newest first. Each tweet costs 1 credit. - GETfindCommunities
/api/v1/x/communities/find?q=stringReturns the communities X finds for a keyword, in X's order. Each community costs 1 credit. To search the tweets in Communities, use /x/communities/search. - GETgetPopularCommunities
/api/v1/x/communities/popularReturns the communities X ranks highest under a topic or subtopic. Name it by topicId or by topic name from /x/communities/topics. Each community costs 1… - GETgetCommunityTopics
/api/v1/x/communities/topicsReturns the community topics with their subtopics. Pass an ID as topicId, or a name as topic, to /x/communities/popular. Each top-level topic costs 1 credit,… - GETgetSuggestedCommunities
/api/v1/x/communities/suggestedReturns the communities X suggests, with their full public fields. X picks them per request, so 2 calls can differ. An empty list is free. Each community… - GETsearchCommunities
/api/v1/x/communities/search?q=stringReturns 1 page of tweets, not community records. Add communityId to search 1 Community, or leave it out to search every Community. To find communities by… - GETgetAllCommunityTweets
/api/v1/x/communities/tweets?q=stringReturns 1 resumable page of tweets. Add communityId to search 1 Community, or leave it out to search every Community.
Community Notes
- GETgetCommunityNotesContributor
/api/v1/x/community-notes/contributors/:aliasReturns 1 Community Notes contributor by the alias X gives them. Includes note counts by rating, rating counts & the deleted notes count. Each lookup costs 1… - GETlistCommunityNotesContributorNotes
/api/v1/x/community-notes/contributors/:alias/notesReturns a contributor's notes, newest first, each with the post it is on. Includes notes X has not rated helpful. Each note costs 1 credit. Follow next_cursor… - GETlistCommunityNotesContributorDeletedNotes
/api/v1/x/community-notes/contributors/:alias/deleted-notesReturns the notes a contributor deleted, newest first. X keeps each note's ID, times, rating & tags. A notice replaces its text & post. Each note costs 1…
Composition
- POSTcompose
/api/v1/composeUses xai-org/x-algorithm facts to compose and refine text. The score step checks text. It never predicts reach or engagement. - GETlistDrafts
/api/v1/draftsLists private Xquik drafts. It cannot access native X drafts. - POSTcreateDraft
/api/v1/draftsStores a private Xquik draft. It never publishes or creates native X drafts. - GETgetDraft
/api/v1/drafts/:idReturns 1 private Xquik draft. It cannot access native X drafts. - DELETEdeleteDraft
/api/v1/drafts/:idDeletes 1 Xquik draft, not native X drafts or published posts. - GETlistStyles
/api/v1/stylesReturns cached writing style profiles for the account. - POSTanalyzeStyle
/api/v1/stylesBuilds a writing style profile from recent public posts. - GETcompareStyles
/api/v1/styles/compare?username1=string&username2=stringCompares language and engagement signals across 2 style profiles. - GETgetStyle
/api/v1/styles/:idReturns 1 cached writing style profile. - PUTsaveStyle
/api/v1/styles/:idCreates, replaces, or renames a style profile from supplied posts. - DELETEdeleteStyle
/api/v1/styles/:idPermanently removes 1 cached style profile. - GETgetStylePerformance
/api/v1/styles/:id/performanceReturns engagement metrics for an analyzed public X profile. - GETgetRadar
/api/v1/radarReturns current topics and sources for writing research.
Draws
- GETlistDraws
/api/v1/drawsReturns giveaway draws owned by the authenticated account. - POSTcreateDraw
/api/v1/drawsChecks credits, then draws winners from inspected replies & reposters. Remaining credits cap the candidates. An API key at its monthly budget gets 403… - GETgetDraw
/api/v1/draws/:idReturns draw rules, status, candidates, and selected winners. - GETexportDraw
/api/v1/draws/:id/export?format=csvDownloads draw evidence in the requested format.
Events
- GETlistEvents
/api/v1/eventsReturns monitor events with cursor pagination and filters. - GETstreamEvents
/api/v1/events/streamStreams the account's monitor events as server-sent events, each named by its event type and numbered by its event ID. A reconnect that sends Last-Event-ID… - GETgetEvent
/api/v1/events/:idReturns 1 monitor event owned by the account.
Extractions
- GETlistExtractions
/api/v1/extractionsReturns extraction jobs with status and result counts. - POSTcreateExtraction
/api/v1/extractionsStarts 1 single-target or multi-target extraction. Follow waitUrl, then page statusUrl once it completes. An API key at its monthly budget gets 403… - POSTestimateExtraction
/api/v1/extractions/estimateEstimates extraction cost without creating a job. You can price a bulk job before you run it. - GETgetExtraction
/api/v1/extractions/:idReturns status and up to 1,000 results. Follow nextCursor when hasMore is true. - DELETEcancelExtraction
/api/v1/extractions/:idCancels an active extraction without charging or saving rows. - GETexportExtraction
/api/v1/extractions/:id/export?format=csvDownloads completed extraction results in the requested format. JSON rows also keep each result's nested enrichmentData, as GET /extractions/{id} returns it.…
Guest Wallets
- POSTcreateGuestWallet
/api/v1/guest-walletsCreate a one-use hosted checkout after the user confirms $10-$250 USD. The request creates no charge. It returns a paid-read API key without an Xquik account.… - POSTtopUpGuestWallet
/api/v1/guest-wallets/topupsCreate a one-use hosted checkout after the user confirms a $10-$250 USD amount for an existing paid-read guest key. The key remains the same. This request… - GETgetGuestWalletStatus
/api/v1/guest-wallets/statusPoll after payment. Use usable to decide whether paid reads can run. An active wallet can remain usable while a top-up is pending. A new wallet becomes usable…
Jobs
- GETsearchJobs
/api/v1/x/jobs/search?q=engineerReturns job listings with title, location, salary, company & apply link. Add filters to narrow them. A closed job does not appear & costs nothing. Follow… - GETgetJobLocations
/api/v1/x/jobs/locations?q=new yorkReturns the places whose names match a query, each with the location ID that GET /x/jobs/search takes. No match returns an empty list, free. - GETgetJob
/api/v1/x/jobs/:idReturns a public job listing with its description as text & Markdown, work type, seniority, salary, company & apply link. A job that closed returns…
Lists
- GETsearchLists
/api/v1/x/lists/search?q=stringReturns 1 page of public Lists with member counts, banners & owner profiles. X may rank the Lists differently per request. Pass next_cursor as cursor for the… - GETgetList
/api/v1/x/lists/:idReturns 1 public X List as its page on X shows it. Accepts the List ID or the URL-encoded List URL, such as x.com/i/lists/4143408. A private List answers 404… - GETgetListFollowers
/api/v1/x/lists/:id/followersReturns a public List's followers with resumable or standard pagination. A private List answers 404 list_not_found. - GETgetListMembers
/api/v1/x/lists/:id/membersReturns a public List's members with resumable or standard pagination. A private List answers 404 list_not_found. - GETgetListTweets
/api/v1/x/lists/:id/tweetsOmit mode for resumable maximum coverage. Pass next_cursor unchanged. Standard keeps legacy pagination. A private List answers 404 list_not_found. List…
Media
- POSTdownloadMedia
/api/v1/x/media/downloadDownloads images and videos attached to selected tweets. Saving the same media again is free. Removed media isn't billed, & a single-post download with all…
Monitors
- GETlistMonitors
/api/v1/monitorsReturns account monitors with their current operating states. - POSTcreateMonitor
/api/v1/monitorsCreates an account monitor, with no count limit. Active monitors check every second for 30 credits an hour, events & webhook deliveries included. That hourly… - GETlistKeywordMonitors
/api/v1/monitors/keywordsReturns keyword monitors with their current operating states. - POSTcreateKeywordMonitor
/api/v1/monitors/keywordsCreates a keyword monitor, with no count limit. Active monitors check every second for 30 credits an hour, events & webhook deliveries included. That hourly… - GETgetKeywordMonitor
/api/v1/monitors/keywords/:idReturns configuration and status for 1 keyword monitor. - DELETEdeleteKeywordMonitor
/api/v1/monitors/keywords/:idStops 1 keyword monitor, then removes its stored events in bounded batches. Poll statusUrl until the monitor returns 404. - PATCHupdateKeywordMonitor
/api/v1/monitors/keywords/:idUpdates a keyword monitor's event types or active state. A monitor turned on again starts from that moment, with no event for a post made while it was off.… - GETlistPostMonitors
/api/v1/monitors/postsReturns post monitors with each post's 6 metrics, their current values & gains since tracking began. - POSTcreatePostMonitor
/api/v1/monitors/postsCreates a monitor for 1 X post. It tracks replies, quotes, edits, deletion & 6 metrics, for 30 credits an hour with events & webhook deliveries included. That… - GETgetPostMonitor
/api/v1/monitors/posts/:idReturns 1 post monitor with its post & the 6 metrics, each with its current value & gain since tracking began. - DELETEdeletePostMonitor
/api/v1/monitors/posts/:idStops 1 post monitor, then removes its stored events & metric history in bounded batches. Poll statusUrl until the monitor returns 404. - PATCHupdatePostMonitor
/api/v1/monitors/posts/:idUpdates a post monitor's label, event types or active state. Turning a paused monitor on reads the post first, & answers 409 while X hides it. - GETgetPostMonitorMetrics
/api/v1/monitors/posts/:id/metricsReturns 1 bucket per hour with each metric's value at the hour's end & its gain over that hour. The last bucket is the current hour. Hours before tracking… - PUTupsertMonitorByUsername
/api/v1/monitors/username/:usernameCreates the monitor if it does not exist, or updates it if it does. Send the same call twice & you still have 1 monitor. A new monitor answers 201 & an update… - GETgetMonitor
/api/v1/monitors/:idReturns configuration and status for 1 account monitor. - DELETEdeleteMonitor
/api/v1/monitors/:idStops 1 account monitor, then removes its stored events in bounded batches. Poll statusUrl until the monitor returns 404. - PATCHupdateMonitor
/api/v1/monitors/:idUpdates an account monitor's event types or active state. A monitor turned on again starts from that moment, with no event for a post made while it was off.…
Spaces
- GETsearchSpaces
/api/v1/x/spaces/search?q=from:solanaReturns public Spaces, each once, with the fields of GET /x/spaces/{id}. Latest & Top find live, scheduled or ended Spaces & accept X search operators. Live &… - GETgetSpace
/api/v1/x/spaces/:idReturns 1 X Space as X shows it, live, scheduled or ended. Accepts the Space ID or the URL-encoded Space URL. A Space X limits to subscribers or a community… - GETgetSpaceReplay
/api/v1/x/spaces/:id/replayReturns the recording X plays back once a Space is over, in state Ended or TimedOut. Accepts the Space ID or the URL-encoded Space URL. Check state and…
Sports
- GETlistFootballGames
/api/v1/x/sports/:league/gamesLists NFL or college football games in a time window, with teams & scores. Use it to find game IDs & team IDs. Without from or to, X picks about 5 weeks… - GETgetFootballScoreboard
/api/v1/x/sports/:league/games/:idReturns 1 game's scoreboard. It has the teams, the score by period, the status & clock, down & distance, the venue & the latest play. Each request costs 1… - GETgetSportsGameAudience
/api/v1/x/sports/:league/games/:id/audienceReturns who follows 1 game on X. It has live viewers, fan picks per team & the game chat's state. Each request costs 1 credit. - GETgetFootballBoxScore
/api/v1/x/sports/:league/games/:id/box-scoreReturns each team's totals & each player's stats for 1 game. Stats cover passing, rushing, receiving, defense, kicking & returns. A game that has not started… - GETgetFootballPlays
/api/v1/x/sports/:league/games/:id/playsReturns every drive & play of 1 game, by quarter. Each play has its clock, down & distance, details, penalties & linked posts. Each request costs 1 credit. - GETgetFootballRoster
/api/v1/x/sports/:league/games/:id/rosterReturns both teams' players for 1 NFL game. Each player has a jersey, position, headshot & X account. Each request costs 1 credit. - GETgetFootballPlayerProps
/api/v1/x/sports/:league/games/:id/player-propsReturns the player prop lines & American odds X shows for 1 NFL game. X lists props before & during a game. Other games return no categories. Each request… - GETgetSportsGamePosts
/api/v1/x/sports/:league/games/:id/postsReturns a game's top or latest posts, plus an X search you can run for more. Works before, during & after the game. Pages hold up to 20 posts, & each post…
Subscribe
- POSTsubscribe
/api/v1/subscribeCreate a subscription checkout URL or a billing page link only after the user confirms. The request never completes payment by itself. An account with a plan… - GETgetCredits
/api/v1/creditsReturns the account credit balance and usage context. - POSTtopUpCredits
/api/v1/credits/topupCreate a hosted checkout only after the user confirms. The request never completes payment or adds credits. - GETgetCreditTopupStatus
/api/v1/credits/topup/status?session_id=stringReturns verification status for a credit top-up. - POSTquickTopUpCredits
/api/v1/credits/quick-topupCharges a saved payment method only after explicit confirmation. Send 1 Idempotency-Key per purchase. Reuse it within 24 hours to retry a lost answer, & the…
Support
- GETdownloadSupportAttachment
/api/v1/support/attachments/:idStreams an authenticated user's support image or video. Video requests support 1 standard byte range for seeking and resumable playback. - GETlistTickets
/api/v1/support/ticketsReturns support tickets owned by the authenticated user, latest activity first. - POSTcreateTicket
/api/v1/support/ticketsCreates a support ticket with an initial message. - GETgetTicket
/api/v1/support/tickets/:idReturns 1 support ticket with its message history. - PATCHupdateTicketStatus
/api/v1/support/tickets/:idChanges the open or closed state of a support ticket. - POSTaddTicketMessage
/api/v1/support/tickets/:id/messagesAdds a message to an existing support ticket.
Trends
- GETgetXTrends
/api/v1/x/trendsReturns X's current trends for a place you choose. Pick it by woeid, country or location name. Without one, trends are worldwide. Add at to read what was… - GETgetXTrendsHistory
/api/v1/x/trends/historyReturns the Twitter trends archive of a place, as the lists X showed there over a range of time. Use it for trending on Twitter yesterday, last week or any… - GETgetXTrendLocations
/api/v1/x/trends/locationsReturns the places X offers trends for. Pass a location's woeid to /x/trends. Each returned location costs 1 credit. - GETgetXNewsStoryVersions
/api/v1/x/news/:id/versionsReturns each version X wrote of 1 AI news story. Each version has its time, headline & text, oldest first, so you can see how the story changed. Each request… - GETgetXHashflags
/api/v1/x/hashflagsReturns X's hashflags, the custom emoji X shows after some hashtags. Lists the ones running now unless activeOnly is false. Each returned hashflag costs 1… - GETgetTrends
/api/v1/trendsReturns current regional trends through the compatibility route. Each request costs 1 credit, however many trends it returns.
Tweets
- GETgetBatchTweets
/api/v1/x/tweets?ids=stringReturns public tweet records for the requested IDs. Batch post lookups miss fewer posts. A post ID listed twice in a batch is billed once. - GETsearchXPlaces
/api/v1/x/places/search?q=stringFinds places on X by name. Pass a place's id as place to /x/tweets/search to read posts tagged there. X ranks the places, so their order can differ between… - GETsearchTweets
/api/v1/x/tweets/searchTweets include authors, like counts, media, URLs & cursors. Omit mode for maximum coverage. Reuse next_cursor with unchanged filters. Searches return posts… - GETgetTopTweets
/api/v1/x/tweets/topReturns the tweets X ranks highest by 1 metric over the last day, week or month. Covers all of X unless you pick a country or a language. Pages hold up to 20… - GETlookupTweet
/api/v1/x/tweets/:idReturns 1 public tweet with author, metrics, and media. Posts carry note text, edits, Community Notes, reach labels, reply controls & live events. - GETgetTweetFavoriters
/api/v1/x/tweets/:id/favoritersReturns who liked a post. X shows likers only to the post author. Xquik reads them through your connected X account that wrote the post. Without a connected… - GETgetBookmarks
/api/v1/x/bookmarksReturns your X account's bookmarks. Without your own connected X account, it answers 424 account_required. Without X Premium, a folder answers 424… - GETgetBookmarkFolders
/api/v1/x/bookmarks/foldersReturns your X account's bookmark folders. Without your own connected X account, it answers 424 account_required. Without X Premium, it answers 424… - GETgetTimeline
/api/v1/x/timelineReturns the home timeline of 1 of your connected X accounts. Without one, it answers 424 account_required. Each cursor continues the same account's timeline.… - GETgetTweetQuotes
/api/v1/x/tweets/:id/quotesReturns public posts quoting the tweet, newest first, replies included. Drop them with replies=exclude. Send queryType=Top for the quotes X ranks highest.… - GETgetTweetReplies
/api/v1/x/tweets/:id/repliesReturns direct replies with automatic maximum coverage and pagination. Reply exports work from any post ID or link. Complete mode adds nested replies,… - GETgetTweetRepostCheck
/api/v1/x/tweets/:id/retweeters/check?user=nasaReturns whether 1 account reposted the post. It finds recent reposts. An older repost can return false, with complete false. Each check costs 1 credit. - GETgetTweetRetweeters
/api/v1/x/tweets/:id/retweetersReturns a post's reposters. includeRetweetTimestamp adds retweeted_at in Unix seconds. Null means Xquik found no repost time. The created field is the… - GETgetTweetRetweeterIds
/api/v1/x/tweets/:id/retweeter-idsReturns the user IDs of a post's reposters, in the order & pages of /x/tweets/{id}/retweeters. Use it when you need IDs only. Each ID costs 1 credit. A post… - GETgetTweetHiddenReplies
/api/v1/x/tweets/:id/hidden-repliesReturns the replies the post's author hid, oldest first, with the replies to them. A post without hidden replies returns an empty list. - GETgetTweetThread
/api/v1/x/tweets/:id/threadReturns visible posts from the selected conversation thread. Results exclude X ads. Threads include every post & the author's own replies. - GETtranslateTweet
/api/v1/x/tweets/:id/translation?language=trReturns X's own translation of 1 public tweet into the language you pick, with the links, mentions, and tags X places in the translated text. Posts & bios can… - GETgetTweetInsights
/api/v1/x/tweets/:id/insightsReturns engagement insights for 1 tweet. They are engagements per hour since it went up, per view and per follower of its author, and how far it spread. Each… - GETgetTweetEmbed
/api/v1/x/tweets/:id/embedReturns the HTML that X gives websites to embed 1 public tweet, with the tweet's link and author. - GETresolveLinks
/api/v1/x/links/resolve?urls=https://t.co/Xe1nm2pkSXReturns where each t.co link leads, as X's own redirect says. Xquik reads the redirect and never visits the target site. A link t.co does not have comes back… - GETgetTweetSubtitles
/api/v1/x/tweets/:id/subtitlesReturns the caption tracks of 1 public tweet's videos. Each track has its language, name, timed cues, and full text. A tweet without video, or a video without…
Users
- GETgetBatchUsers
/api/v1/x/users/batchReturns public profiles for user IDs, usernames or profile links. Send ids or usernames, not both. Each returned profile costs 1 credit. - GETgetBatchUserTweets
/api/v1/x/users/batch/tweetsReturns the newest posts of users named by user ID, username or profile link, in the order named. Send ids or usernames, not both. Each post costs 1 credit. A… - GETsearchUsers
/api/v1/x/users/search?q=stringReturns public profiles matching a name or username. - GETautocompleteSearch
/api/v1/x/search/autocomplete?q=nasaReturns the accounts, topics, hashtags & cashtags X suggests while someone types a search. X may rank them differently per request. Costs 1 credit per… - GETgetUser
/api/v1/x/users/:idReturns 1 public profile with counts and verification details. Profiles yield emails, phones & links tagged by network. Account location comes with country… - GETcheckFollow
/api/v1/x/followers/check?source=string&target=stringReturns whether 1 public account follows another, & the reverse, with each account's username & user ID as X names them. - GETgetUserTweets
/api/v1/x/users/:id/tweetsFor the newest posts of 2 to 20 users, use getBatchUserTweets. For more, use createExtraction with tweet_search_extractor & targetUsernames. Omit mode for… - GETgetUserReplies
/api/v1/x/users/:id/repliesReturns target-authored posts & replies, without other authors' context. Omit mode for automatic maximum coverage. Pass next_cursor unchanged. Cursors from… - GETgetUserLikes
/api/v1/x/users/:id/likesReturns your X account's likes. Without your own connected X account, it answers 424 account_required. Others' likes get 424 likes_unavailable. - GETgetUserMedia
/api/v1/x/users/:id/mediaReturns public media posts from the selected user. - GETgetUserAffiliates
/api/v1/x/users/:id/affiliatesReturns the accounts an organization lists as its affiliates, in X's order. An account without affiliates returns an empty list. - GETgetUserSubscriptions
/api/v1/x/users/:id/subscriptionsReturns the creators the selected user subscribes to, in X's order. An account that hides its subscriptions returns an empty list. - GETgetUserLists
/api/v1/x/users/:id/listsReturns the public X Lists the selected user created, in X's order, as the profile's Lists tab shows them. Each List costs 1 credit. A protected account… - GETgetUserListMemberships
/api/v1/x/users/:id/list-membershipsReturns the public X Lists that include the selected user, as the profile's List memberships page shows them. Each List costs 1 credit. A protected account… - GETgetUserArticles
/api/v1/x/users/:id/articlesReturns the posts on the user's Articles tab, newest first. Each post's article holds the Article's ID, title, preview, cover & dates. Read the full text with… - GETgetUserHighlights
/api/v1/x/users/:id/highlightsReturns the posts on the user's Highlights tab, in X's order. An account without highlights returns an empty list. - GETgetFollowersYouKnow
/api/v1/x/users/:id/followers-you-knowReturns the mutual followers your X account sees. Without your own connected X account, it answers 424 account_required. - GETgetSimilarUsers
/api/v1/x/users/:id/similarReturns the public accounts X lists as similar to the selected user, in X's order. Each account costs 1 credit. Similar-account lists come back fuller. - GETgetNotifications
/api/v1/x/notificationsReturns your X account's notifications. Without your own connected X account, it answers 424 account_required. - GETgetDmHistory
/api/v1/x/dm/:userId/history?account=stringReturns message history with 1 user for the connected X account. - GETtranslateUserBio
/api/v1/x/users/:id/translation?language=esReturns X's own translation of 1 profile's bio into the language you pick, with the links, mentions, and tags X places in the translated text. A profile… - GETgetUserFollowerAudit
/api/v1/x/users/:id/follower-auditReads the newest followers of a public account & returns a follower audit. It gives each follower 1 class with its score & signals, then adds coverage, a… - GETgetUserInsights
/api/v1/x/users/:id/insightsReturns engagement insights for 1 profile. They are engagement rate, averages per post and posting rate, from its counts and its most recent posts. It reads… - GETgetUserLiveStatus
/api/v1/x/users/:id/liveSays whether 1 user is broadcasting live video on X right now, with their latest broadcast, live or ended. Each check costs 1 credit. - GETcheckShadowban
/api/v1/x/users/:id/shadowbanChecks 1 X account for a search ban, a search suggestion ban, reply deboosting & a reply lock. It also tests timeline visibility & early engagement, reads the… - GETgetUserFollowerIds
/api/v1/x/users/:id/follower-idsReturns the user IDs of the selected user's followers, newest first, up to 5,000 a page. Use it when you need IDs only. Each ID costs 1 credit. - GETgetUserFollowingIds
/api/v1/x/users/:id/following-idsReturns the user IDs of the accounts the selected user follows, newest first, up to 5,000 a page. Use it when you need IDs only. Each ID costs 1 credit. - GETgetUserFollowers
/api/v1/x/users/:id/followersReturns public follower profiles for the selected user, newest first. Follower & following exports return full lists. Ads & promoted entries never reach your… - GETgetUserFollowing
/api/v1/x/users/:id/followingReturns public profiles followed by the selected user. Follower & following exports return full lists. - GETgetUserMentions
/api/v1/x/users/:id/mentionsReturns public posts mentioning the selected user. - GETgetUserVerifiedFollowers
/api/v1/x/users/:id/verified-followersReturns verified public profiles following the selected user. Verified follower exports return full lists too.
Webhooks
- GETlistWebhooks
/api/v1/webhooksReturns configured webhook endpoints and delivery states. - POSTcreateWebhook
/api/v1/webhooksRegisters an endpoint for signed event deliveries. - POSTcreateTelegramLink
/api/v1/webhooks/telegramReturns a t.me link to @XquikBot that connects a Telegram chat to the account's monitor events. Opening it & pressing Start connects the chat, which then gets… - DELETEdeleteWebhook
/api/v1/webhooks/:idStops future deliveries to the selected webhook. - PATCHupdateWebhook
/api/v1/webhooks/:idUpdates an endpoint, event selection, or delivery settings. - GETlistWebhookDeliveries
/api/v1/webhooks/:id/deliveriesReturns delivery attempts and response outcomes, newest first. - POSTtestWebhook
/api/v1/webhooks/:id/testSends a signed test event to the configured endpoint. - POSTresumeWebhook
/api/v1/webhooks/:id/resumeTests the endpoint before resuming a manually paused webhook.
X Accounts
- GETlistXAccounts
/api/v1/x/accountsReturns connected accounts in creation order. Omit pagination for up to 10,000 accounts. Send limit or cursor for legacy pagination. - POSTconnectXAccount
/api/v1/x/accountsConnects an X account. Takes a dashboard session, or an API key holding connectsXAccounts. With a key, your backend receives the user's X password & 2FA… - GETlistXAccountConnectionLinks
/api/v1/x/account-connection-linksLists your connect links, newest first, with apiKeyId naming the API key that made each one, or null for a dashboard session. Use it to find and revoke the… - POSTcreateXAccountConnectionLink
/api/v1/x/account-connection-linksCreates a link to a page Xquik hosts, where a person connects an X account with no Xquik signup. Your backend never receives their password or 2FA secret, and… - GETgetXAccountConnectionLink
/api/v1/x/account-connection-links/:idReads what happened on a link. status reads connected once the person finishes, with xUserId, xUsername & health. It never holds the token. Takes a Full… - DELETErevokeXAccountConnectionLink
/api/v1/x/account-connection-links/:idStops a link working. An account it already connected stays connected. Takes a Full access API key holding connectsXAccounts, or a dashboard session. - GETgetXAccountConnectionAttempt
/api/v1/x/account-connection-attempts/:idReturns progress for an X account connection attempt. An ID this account never started reads as pending, the same as one still registering. Takes a dashboard… - POSTsubmitXAccountConnectionChallenge
/api/v1/x/account-connection-challenges/:id/submitSubmits the email code X asked for during a connect or reconnect. Takes a dashboard session, or an API key holding connectsXAccounts. - GETgetXAccount
/api/v1/x/accounts/:idReturns 1 connected X account and its current status. - DELETEdisconnectXAccount
/api/v1/x/accounts/:idDisconnects 1 X account and removes stored session access. Only a new sign-in restores the account. Takes a dashboard session, or an API key holding… - POSTreauthXAccount
/api/v1/x/accounts/:id/reauthSigns an existing X account in again. Takes a dashboard session, or an API key holding connectsXAccounts. With a key, your backend receives the new X… - POSTbulkRetryXAccounts
/api/v1/x/accounts/bulk-retryMarks each connected account that failed for a passing reason as ready to use again. Name accounts in accountIds to retry only those. Takes a dashboard…
X Write
- POSTcreateTweet
/api/v1/x/tweetsPublishes a post through a connected X account. Writes don't post twice. Posting paces itself to protect your linked X accounts. Replies land on the right post. - GETgetWriteActionStatus
/api/v1/x/write-actions/:idReturns the current state of an asynchronous write action. - DELETEdeleteTweet
/api/v1/x/tweets/:idDeletes an authored post through a connected X account. - POSTlikeTweet
/api/v1/x/tweets/:id/likeLikes a post through a connected X account. - DELETEunlikeTweet
/api/v1/x/tweets/:id/likeRemoves a like through a connected X account. - POSTbookmarkTweet
/api/v1/x/tweets/:id/bookmarkBookmarks a post through a connected X account. Only that account sees its bookmarks, and GET /x/bookmarks lists them. - DELETEunbookmarkTweet
/api/v1/x/tweets/:id/bookmarkRemoves a bookmark through a connected X account. - POSTretweet
/api/v1/x/tweets/:id/retweetReposts a tweet through a connected X account. - DELETEunretweet
/api/v1/x/tweets/:id/retweetRemoves a repost through a connected X account. - POSTfollowUser
/api/v1/x/users/:id/followFollows a user through a connected X account. Once X rate limits an account's follows, its follows get 429 until X's reset. That hold lasts 24 hours at most,… - DELETEunfollowUser
/api/v1/x/users/:id/followUnfollows a user through a connected X account. - POSTblockUser
/api/v1/x/users/:id/blockBlocks a user through a connected X account. X removes follows both ways, and unblocking doesn't restore them. - DELETEunblockUser
/api/v1/x/users/:id/blockUnblocks a user through a connected X account. - POSTmuteUser
/api/v1/x/users/:id/muteMutes a user through a connected X account. The user's posts leave that account's timelines, and X doesn't tell the user. - DELETEunmuteUser
/api/v1/x/users/:id/muteUnmutes a user through a connected X account. - POSTremoveFollower
/api/v1/x/users/:id/remove-followerRemoves a follower from a connected X account. - POSTsendDm
/api/v1/x/dm/:userIdSends a direct message through a connected X account. Once X rate limits an account's DMs, its DMs get 429 until X's reset. That hold lasts 24 hours at most,… - DELETEdeleteDm
/api/v1/x/dm/:userId/messages/:messageId?account=stringDeletes 1 DM from the account's side. The other person keeps it. Success means the DM is gone from the account's conversation. A DM that stays gets 422… - POSTuploadMedia
/api/v1/x/mediaUploads media and returns an identifier for later writes. - PATCHupdateProfile
/api/v1/x/profileUpdates editable fields on a connected X profile. - PATCHupdateAvatar
/api/v1/x/profile/avatarReplaces the avatar on a connected X profile. - PATCHupdateBanner
/api/v1/x/profile/bannerReplaces the banner on a connected X profile. - POSTcreateCommunity
/api/v1/x/communitiesDeprecated. X isn't accepting new Communities. This call answers x_community_creation_closed & charges nothing. - DELETEdeleteCommunity
/api/v1/x/communities/:idDeletes an owned X Community through a connected account. - POSTjoinCommunity
/api/v1/x/communities/:id/joinJoins an X Community through a connected account. - DELETEleaveCommunity
/api/v1/x/communities/:id/joinLeaves an X Community through a connected account.
API details
- Base URL
https://xquik.com- Authentication
- An API key in the x-api-key header
A bearer token in the Authorization header
An API key in the __Host-xquik_session cookie - Operations
- 224 operations on 185 pathsGET 138POST 52DELETE 20PATCH 11PUT 3
1 marked deprecated - Main resources
- Users 31X Write 26Tweets 21Monitors 17Communities 13Composition 13X Accounts 12Agent Discovery 8Sports 8Webhooks 8
- Response formats
application/jsonapplication/octet-streamtext/event-streamtext/html- Webhooks
- 1 described
- Description format
- OpenAPI 3.1.0, API version
1.0 - Links
- OpenAPI document · Support
- Listed from
- Xquik's published OpenAPI description
How to test the Xquik API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Xquik API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the x-api-key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “listApiKeys” (GET /api/v1/api-keys), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Xquik API?
Xquik is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp. Read and automate X. Paid reads accept… It is listed under Social and has 224 endpoints.
Who publishes the Xquik API?
It is listed from Xquik's public API description (an OpenAPI document), not published by Xquik on Swastik Codes. Anyone who controls xquik.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Xquik API?
Requests go to https://xquik.com. Endpoint paths are added to this base URL.
How do I authenticate with the Xquik API?
It accepts 3 methods: an API key in the x-api-key header; A bearer token in the Authorization header; an API key in the __Host-xquik_session cookie.
How many endpoints does the Xquik API have?
224 operations on 185 paths (138 GET, 52 POST, 20 DELETE, 11 PATCH, 3 PUT). The largest groups are Users, X Write, Tweets, Monitors.
Is forking the Xquik API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.