API reference

Base URL https://api.xsignalfeed.com. All responses are JSON in the envelope described under Errors when they fail, and carry the headers listed under Rate limits when they succeed. Fields marked * are required.

Monitoring

Choose which accounts this key follows. For each of them you get every event type your key allows, or only the types you pick.

EndpointNameScopeCredits
GET /v1/monitor/targetsList monitored accountstargets:read0
POST /v1/monitor/targetsMonitor an accounttargets:write0
GET /v1/monitor/targets/{target}Get a monitored accounttargets:read0
PATCH /v1/monitor/targets/{target}Choose event types for an accounttargets:write0
DELETE /v1/monitor/targets/{target}Stop monitoring an accounttargets:write0
POST /v1/monitor/targets:batchBatch monitor operationstargets:write0

Keywords

Watch X search for phrases. The query accepts X's own syntax: exact phrases in quotes, OR, -exclusions, #hashtags, $cashtags, from:, to:, lang:, filter:media, -filter:replies, -filter:retweets. We watch the "Latest" tab, so results are chronological, and any language or script works.

EndpointNameScopeCredits
GET /v1/keywordsList keywordskeywords:read0
POST /v1/keywordsWatch a keywordkeywords:write0
DELETE /v1/keywords/{keyword_id}Remove a keywordkeywords:write0

Stream & history

The WebSocket is described under Streaming; this is its REST companion for catching up.

EndpointNameScopeCredits
GET /v1/eventsEvent historyreplay0

Users

Profiles, follow lists, media, mentions, subscriptions and user search, read from X now. Each call costs the credits shown.

EndpointNameScopeCredits
GET /v1/users/{screen_name}Get user by usernamereads1
GET /v1/users/by-id/{user_id}Get user by idreads1
GET /v1/users/batchGet users by idsreads1 per id
GET /v1/users/{screen_name}/aboutGet account detailsreads1
GET /v1/users/{screen_name}/tweetsGet user postsreads2
GET /v1/users/{screen_name}/mediaGet user mediareads2
GET /v1/users/{screen_name}/mentionsGet user mentionsreads2
GET /v1/users/{screen_name}/followingGet followingreads2
GET /v1/users/{screen_name}/followersGet followersreads2
GET /v1/users/{screen_name}/verified_followersGet verified followersreads2
GET /v1/users/{screen_name}/subscriptionsGet subscriptionsreads2
GET /v1/users/searchSearch usersreads2
GET /v1/users/{screen_name}/relationship/{other_screen_name}Check follow relationshipreads1

Tweets

Posts by id, with their replies, quotes, reposters, thread and article. Each call costs the credits shown.

EndpointNameScopeCredits
GET /v1/tweets/{tweet_id}Get a postreads1
GET /v1/tweetsGet posts by idsreads1
GET /v1/tweets/{tweet_id}/repliesGet repliesreads2
GET /v1/tweets/{tweet_id}/quotesGet quotesreads2
GET /v1/tweets/{tweet_id}/retweetersGet repostersreads2
GET /v1/tweets/{tweet_id}/threadGet a threadreads2
GET /v1/tweets/{tweet_id}/articleGet an articlereads1

X search in its own syntax, latest or top results, paged.

EndpointNameScopeCredits
GET /v1/searchSearch postsreads2
GET /v1/search/trendsSearch a trendreads2

Lists

Timeline and membership of any public list.

EndpointNameScopeCredits
GET /v1/lists/{list_id}/tweetsGet list postsreads2
GET /v1/lists/{list_id}/membersGet list membersreads2

Communities

Info, members, moderators and posts of an X community.

EndpointNameScopeCredits
GET /v1/communities/{community_id}Get a communityreads1
GET /v1/communities/{community_id}/membersGet community membersreads2
GET /v1/communities/{community_id}/moderatorsGet community moderatorsreads2
GET /v1/communities/{community_id}/tweetsGet community postsreads2

What is trending on X right now, by category.

EndpointNameScopeCredits
GET /v1/trendsGet trendsreads2

Account

What this key may do, how much it has used, where webhooks go.

EndpointNameScopeCredits
GET /v1/accountGet account—0
GET /v1/account/usageGet usage—0
GET /v1/account/webhookGet webhookwebhook0
PUT /v1/account/webhookSet webhookwebhook0

Meta & status

Public, cached for five minutes, no key needed. Build your validation and your UI from these instead of copying this page.

EndpointNameScopeCredits
GET /v1/meta/event-typesList event types—0
GET /v1/meta/scopesList scopes—0
GET /v1/meta/plansList plans—0
GET /v1/meta/versionsList versions—0
GET /v1/healthHealth—0
GET /v1/statusStatus—0

A machine-readable description of all of the above is at /v1/openapi.json; /v1/docs redirects here.