API reference
X (Twitter) Posts Search API
Keyword search over public X posts, newest or top first: text, author card, like/repost/reply/quote/view counts, media, hashtags, mentions and links — 20 posts a page with cursor pagination.
Endpoint
/v1/x/search-tweetslive · proven1 creditParameters
Query parameters
Useful optional inputs
sort— Choose the documented source ordering before paging through results.Ordering keeps the normal endpoint price and does not guarantee exhaustive results.
fit— Use fit=goal with a task description to replace confidently irrelevant records with recall stubs and reduce agent context.No fit surcharge; full evidence is retained for 24 hours when stored, and the response size target is soft.
dry_run— Read a free estimate before fetching sources or scheduling paid work.Zero credits; cache status and availability are snapshots rather than guarantees.
| Name | Required | Description | Example |
|---|---|---|---|
query | yes | Search terms. X's advanced operators work: from:handle, to:handle, lang:en, min_faves:100, "exact phrase", -word. | Monzo bank |
mode | no | latest (default) for newest first, top for X's relevance ranking. Accepted values: latest, top. Case, spaces, hyphens and underscores are interchangeable. | latest |
cursor | no | Opaque cursor from the previous page's cursor field. | |
from_date | no | ISO date lower bound (translated to X's since_time operator). | 2026-08-01 |
to_date | no | ISO date upper bound (translated to X's until_time operator). | 2026-09-01 |
include_reposts | no | Set true to include reposts or false to exclude them. Set this explicitly and preserve it across pages; omitted behavior can differ across sources. | false |
sort | no | Alias for mode: latest or top. mode takes precedence; otherwise sort takes precedence over sort_by. Equivalent spellings share the response cache. Accepted values: latest, top. Case, spaces, hyphens and underscores are interchangeable. | latest |
sort_by | no | Alias for mode: latest or top. mode, then sort, take precedence. Equivalent spellings share the response cache. Accepted values: latest, top. Case, spaces, hyphens and underscores are interchangeable. | top |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. | 1 |
judgments | no | Add bounded AI labels to eligible returned records (default on). off preserves the original data shape. Unclassified records remain present; labels depend on evidence, time, capacity and the existing request budget. No label surcharge. Accepted values: on, off. Case, spaces, hyphens and underscores are interchangeable. | on |
label | no | Set none to disable labels; default enables the endpoint’s label set. Equivalent to judgments=off. Accepted values: default, none. Case, spaces, hyphens and underscores are interchangeable. | none |
label_evidence | no | Include exact supporting sentences and zero-based sentence indexes when a label has validated evidence. No extra charge or change to decisions. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. | 1 |
exclude | no | Optionally remove confidently labelled engagement bait. Uncertain and unclassified records stay; removed IDs and an owner-bound recall reference are returned. Accepted values: engagement_bait. Case, spaces, hyphens and underscores are interchangeable. | engagement_bait |
fit | no | Use goal to replace confidently irrelevant records with recall stubs. Keeps first, last, relevant and uncertain records; preserves order. Full evidence is stored for 24 hours when available. Accepted values: goal. Case, spaces, hyphens and underscores are interchangeable. | goal |
goal | no | Required with fit=goal: describe the task in at most 600 characters. Supplied text is task context, never permission to act on posts. | Find concrete product complaints |
tokens | no | Optional soft response target for fit=goal, 256–32000. Safety and evidence retention take priority, so the returned result may exceed it. | 4000 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/x/search-tweets?query=Monzo%20bank" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/x/search-tweets?query=Monzo%20bank",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/x/search-tweets?query=Monzo%20bank",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "x",
"endpoint": "/v1/x/search-tweets",
"data": {
"items": [
{
"id": "1900000000000000001",
"text": "Our workspace guide is ready.",
"created_at": "2026-09-01T12:00:00.000Z",
"author": {
"handle": "example_creator",
"name": "Example Creator"
},
"stats": {
"likes": 42,
"retweets": 8,
"replies": 5,
"views": null
}
}
],
"cursor": null,
"has_more": null
},
"credits_used": 1,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: reviewed response shaper. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
items | array | Records in this response page. |
items[].id | string | null | Source identifier. Preserve its exact string value; do not convert large IDs to numbers. |
items[].url | string | null | Original source URL when supplied. |
items[].text | string | null | Post text. |
items[].created_at | string | null | Source publication time, normalized to an ISO date-time when available. |
items[].author | object | null | Nested response fields; optional unless explicitly documented. |
items[].author.id | string | null | Source identifier. Preserve its exact string value; do not convert large IDs to numbers. |
items[].author.handle | string | null | Public account username. |
items[].author.name | string | null | Display name. |
items[].author.url | string | null | Original source URL when supplied. |
items[].stats | object | Nested response fields; optional unless explicitly documented. |
items[].stats.likes | number | null | likes reported by the source; null or absent is unknown, not zero. |
items[].stats.retweets | number | null | retweets reported by the source; null or absent is unknown, not zero. |
items[].stats.replies | number | null | replies reported by the source; null or absent is unknown, not zero. |
items[].stats.quotes | number | null | quotes reported by the source; null or absent is unknown, not zero. |
items[].stats.bookmarks | number | null | bookmarks reported by the source; null or absent is unknown, not zero. |
items[].stats.views | number | null | views reported by the source; null or absent is unknown, not zero. |
items[].in_reply_to_id | string | null | Source identifier. Preserve its exact string value; do not convert large IDs to numbers. |
items[].conversation_id | string | null | Source identifier. Preserve its exact string value; do not convert large IDs to numbers. |
count | number | null | Returned row count when supplied; not the full source total. |
cursor | string | null | Opaque next-page token. A missing token does not prove full history was retrieved. |
has_more | boolean | null | Source continuation indicator; null means unknown. |
_warnings | array | Collection limitations or component warnings. Read before interpreting coverage. |
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference