Skip to main content
GET
Scrape a public tweet by URL

Authorizations

x-api-key
string
header
required

Your API key. Send it in the x-api-key header (or Authorization: Bearer <key>). Create and manage keys from your dashboard.

Query Parameters

url
string
required

Public tweet permalink, e.g. https://x.com/user/status/1234567890

trim
boolean
default:false

Return a trimmed-down response: only the focal tweet with essential fields, and no reply thread (replies/replyCount are omitted).

cache_max_age
enum<string>

Optional. Return a cached result if one this age or newer exists — served for 0 credits with meta.cached=true and meta.cachedAt. Otherwise a fresh scrape runs (1 credit) and refreshes the cache. Omit to always scrape fresh.

Available options:
1d,
3d,
7d,
14d,
30d

Response

The focal tweet and its replies.

data
object
required
meta
object
required

requestId + credit/caching metadata (creditsCharged, creditsRemaining, cached, cachedAt).