X API

Mentions

Public X posts that mention an account, newest first, 20 a page: each as a full post card with its author, counts, media and links, with cursor pagination and an optional date window.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/x/mentionslive · proven3 credits

Try in Playground

Parameters

Query parameters

Name	Required	Description	Example
`handle`	yes	X username without the @.	`monzo`
`cursor`	no	Opaque cursor from the previous page's cursor field.
`from_date`	no	ISO date lower bound on post time.	`2026-08-01`
`to_date`	no	ISO date upper bound on post time.	`2026-09-01`
`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.	`1`

Examples

Make the request

curl

curl "https://www.monocrawl.com/v1/x/mentions?handle=monzo" \
  -H "x-api-key: mn_your_key_here"

TypeScript

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/mentions?handle=monzo",
  { 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

python

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/x/mentions?handle=monzo",
    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.

200 · application/json

{
  "success": true,
  "platform": "x",
  "endpoint": "/v1/x/mentions",
  "data": {
    "items": [],
    "cursor": null
  },
  "credits_used": 3,
  "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`	Nested response fields; optional unless explicitly documented.
`items[].id`	`string \| null`	Exact source identifier; preserve it as a string.
`items[].url`	`string \| null`	Original source URL when supplied.
`items[].platform`	`string \| null`	platform
`items[].title`	`string \| null`	title
`items[].text`	`string \| null`	text
`items[].caption`	`string \| null`	caption
`items[].created_at`	`string \| null`	created at
`items[].author`		Nested response fields; optional unless explicitly documented.
`items[].stats`	`object \| null`	Nested response fields; optional unless explicitly documented.
`items[].stats.likes`	`number \| null`	likes; null is unknown.
`items[].stats.comments`	`number \| null`	comments; null is unknown.
`items[].stats.replies`	`number \| null`	replies; null is unknown.
`items[].stats.shares`	`number \| null`	shares; null is unknown.
`items[].stats.views`	`number \| null`	views; null is unknown.
`count`	`number \| null`	Returned rows, not the total population.
`cursor`	`string \| null`	Opaque continuation; pass unchanged.
`has_more`	`boolean \| null`	Source continuation indicator.
`total`	`number \| null`	Source-reported total; null means unknown.

An empty page is not proof of complete history. Mentions use native mention entities; quotes must identify the quoted post.

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

Mentions

Query parameters

Make the request

Response fields and example

More X reference

First call in under a minute