Skip to content

API reference

Search X

x_search — Search X live as the account: latest or top posts, or people.

x_search · Live read on X (creates a job)

Search X live as the account: latest or top posts, or people. Supports X search operators in query (from:, lang:, min_faves:…). Counts against Read.

REST POST /api/public/v1/accounts/{account}/reads/search
MCP tool x_search
Permission needed accounts.run — Owner, Manager, Operator
Scope group x:read
Group Live reads on X
Shown up front in profiles Operate X accounts

Input

Field Type Required Description
account string (1–100 chars) Yes The X account to use: its X-Buddy account_id (from account_list) or its @handle. Ambiguous names return candidates instead of guessing.
query string (1–500 chars) Yes Search text, X operators allowed.
type latest · top · people No
lang string No Two-letter language code.
max integer (1–1000) No Most results.

Result

Creates a job for the X account's VPS. REST waits up to wait seconds (default 15, max 20): when done it returns 200 with the result, otherwise 202 with Location: /api/public/v1/jobs/{job_id}. The final status is succeeded, failed, cancelled or unknown.

Example

Call over REST

curl -X POST "https://reach-link-craft.lovable.app/api/public/v1/accounts/%40your_x_account/reads/search" \
  -H "Authorization: Bearer $XBUDDY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"ai agents"}'

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "x_search",
    "arguments": {
      "account": "@your_x_account",
      "query": "ai agents"
    }
  }
}

Errors you may get

Back to all operations