Skip to main content

Base URL

Authentication

All requests require an API key. Three methods are supported:

Your First Request

Get a user’s profile:
Response:

Get a Tweet

Response:
All of the following are always-on — no query param needed:
  • text — the complete post text. Long “note tweets” return the full body (not truncated at ~140 chars); for retweets it is rebuilt as RT @user: <full original text>.
  • media — photos/videos/GIFs (type: photo | video | animated_gif). For video/GIF, url is the thumbnail and video_url holds the highest-bitrate mp4; [] when there’s no media.
  • card — link/summary preview (url, title, description, image, domain) or null. The title often carries the key info for link-only posts.
  • article — X long-form article { title, text } or null.
  • entities — parsed mentions[], hashtags[], cashtags[] (raw symbols), and expanded urls[].
  • quoted_tweet / retweeted_tweet — the embedded quoted / original tweet (same shape, one level deep) or null.
All text is returned as correct UTF-8.

Pagination

List endpoints return paginated results. Pass cursor from the previous response to get the next page:
Response structure:
When has_next_page is false or next_cursor is null, there are no more pages.

Error Responses

Next Steps

REST API Reference

Browse all endpoints with interactive playground

WebSocket Guide

Set up real-time event subscriptions