TwittrAPI
Docs
Home timeline

Home timeline

The home timeline of your account.

POST/client/home-timeline

Your account, your proxy, your risk.

Account actions run with the session cookie of your own X account and go out through your own proxy. Use only accounts you control and follow X's rules. Automated posting, following or liking can get the account limited or suspended; that is between you and X. Treat the cookie like a password: it gives full access to the account. Trial keys cannot call these endpoints.

Parameters

  • cookiebody · string · required

    Cookie header of your own logged-in X session. Must contain auth_token and ct0; guest_id is used when present.

  • proxybody · string · required

    Your proxy, format http://user:pass@host:port. The requests to X go out through it. Used only for this request.

  • countbody · integer · optional · default 20

    Tweets to ask X for.

  • include_promoted_contentbody · boolean · optional · default true

    Include promoted tweets.

Body parameters are sent as a JSON object with Content-Type: application/json.

Example request

curl -X POST 'https://api.twittrapi.com/client/home-timeline' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"cookie":"auth_token=...; ct0=...","proxy":"http://user:pass@host:port","count":20}'

Base URL https://api.twittrapi.com, key in the X-API-KEY header. The SDKs do not wrap account actions, so the examples are plain HTTP calls.

Response

Wrapper built by the API: {"status_code": <X status>, "response": "<X response body as a string>"}. The HTTP status is X's status when X answered 4xx or 5xx, otherwise 200. Parse response a second time to get X's JSON.

Simple format (?format=simple or X-Response-Format: simple): Collection of Tweet objects: {data: [Tweet], nextCursor, previousCursor, hasNextPage}. When X reports an error inside the wrapper (for example a tweet that is already liked), the usual wrapper is returned unchanged. Schema.

{
  "status_code": 200,
  "response": "{\"data\":{\"home\":{\"home_timeline_urt\":{\"instructions\":[{\"type\":\"TimelineClearCache\"},{\"entry\":{\"content\":{\"__typename\":\"TimelineTimelineItem\",\"clientEventInfo\":{\"component\":\"pinned_tweets\",\"element\":\"tweet\"},\"entryType\":\"TimelineTimelineItem\",\"itemContent\":{\"__typename\":\"TimelineTweet\",\"itemType\":\"TimelineTweet\",\"socialContext\":{\"contextType\":\"Pin\",\"text\":\"Example text.\",\"type\":\"TimelineGeneralContext\"},\"tweetDisplayType\":\"Tweet\",\"tweet_results\":{\"result\":{\"__typename\":\"Tweet\",\"card\":{\"legacy\":{\"binding_values\":[{\"key\":\"photo_image_full_size_large\",\"value\":{\"image_value\":{\"height\":419,\"url\":\"https://pbs.twimg.com/card_img/2107952823128182784/RyT0hE6P?format=jpg&name=800x419\",\"width\":800},\"type\":\"IMAGE\"}},{\"key\":\"thumbnail_image\",\"value\":{\"image_value\":{\"height\":150,\"url\":\"https://pbs.twimg.com/card_img/2107952823128182784/RyT0hE6P?format=jpg&name=280x150\",\"width\":218},\"type\":\"IMAGE\"}},{\"key\":\"description\",\"value\":{\"string_value\":\"Use the X API with an all-new Developer Console and consumption-based billing. No fixed monthly costs, no monthly caps.\",\"type\":\"STRING\"}}],\"card_platform\":{\"platform\":{\"audience\":{\"name\":\"production\"},\"device\":{\"name\":\"Swift\",\"version\":\"12\"}}},\"name\":\"summary_large_image\",\"url\":\"https://t.co/FS66GuIYJD\",\"user_refs_results\":[]},\"rest_id\":\"https://t.co/FS66GuIYJD\"},\"cashtag_attachments\":[],\"core\":{\"user_results\":{\"result\":{\"__typename\":\"User\",\"action_counts\":{\"favorites_count\":2758},\"affiliates_highlighted_label\":{\"label\":{\"badge\":{\"url\":\"https://pbs.twimg.com/profile_images/1955359038532653056/OSHY3ewP_bigger.jpg\"},\"description\":\"X\",\"url\":{\"url\":\"https://twitter.com/X\",\"urlType\":\"DeepLink\"},\"userLabelDisplayType\":\"Badge\",\"userLabelType\":\"BusinessLabel\"}},\"avatar\":{\"image_url\":\"https://pbs.twimg.com/profile_images/1683501992314798080/xl1POYLw_normal.jpg\"},\"banner\":{\"image_url\":\"https://pbs.twimg.com/profile_banners/2244994945/1690213128\"},\"core\":{\"created_at\":\"Sat Dec 14 04:35:55 +0000 2013\",\"name\":\"Developers\",\"screen_name\":\"XDevelopers\"},\"dm_permissions\":{\"can_dm\":true},\"follow_request_sent\":false,\"has_graduated_access\":true,\"id\":\"VXNlcjoyMjQ0OTk0OTQ1\",\"is_blue_verified\":true,\"location\":{\"location\":\"127.0.0.1\"},\"media_permissions\":{\"can_media_tag\":true},\"notifications_settings\":{\"notifications_enabled\":false},\"parody_commentary_fan_label\":\"None\",\"pinned_items\":{\"tweet_ids_str\":[\"2019881223666233717\"]},\"possibly_sensitive\":false,\"privacy\":{\"protected\":false},\"professional\":{\"category\":[{\"icon_name\":\"IconBriefcaseStroke\",\"id\":1009,\"name\":\"Community\"}],\"professional_type\":\"Business\",\"rest_id\":\"1516891231749517312\"},\"profile_bio\":{\"description\":\"The voice of the X Dev team and your official source for updates, news, and events, related to the X API.\",\"entities\":{\"description\":{},\"url\":{\"urls\":[{\"display_url\":\"docs.x.com\",\"expanded_url\":\"https://docs.x.com/\",\"indices\":[0,23],\"url\":\"https://t.co/NIwHVIVyrN\"}]}}},\"profile_description_language\":\"en\",\"profile_image_shape\":\"Square\",\"profile_metadata\":{\"profile_interstitial_type\":\"\"},\"profile_translation\":{\"translator_type\":\"regular\"},\"relationship_counts\":{\"followers\":698074,\"following\":770},\"relationship_perspectives\":{\"blocked_by\":false,\"blocking\":false,\"followed_by\":false,\"following\":false,\"live_following\":false,\"muting\":false},\"rest_id\":\"2244994945\",\"super_follow_eligible\":false,\"super_followed_by\":false,\"super_following\":false,\"tweet_counts\":{\"media_tweets\":832,\"tweets\":4376},\"verification\":{\"verified\":false,\"verified_type\":\"Business\"},\"website\":{\"url\":\"https://t.co/NIwHVIVyrN\"}}}},\"edit_control\":{\"edit_tweet_ids\":[\"2019881223666233717\"],\"editable_until_msecs\":\"1770415785000\",\"edits_remaining\":\"5\",\"is_edit_eligible\":false},\"grok_analysis_button\":true,\"grok_annotations\":{\"is_image_editable_by_grok\":true},\"grok_translated_post_with_availability\":{\"is_available\":false},\"is_translatable\":false,\"legacy\":{\"bookmark_count\":2803,\"bookmarked\":false,\"conversation_id_str\":\"2019881223666233717\",\"created_at\":\"Fri Feb 06 21:09:45 +0000 2026\",\"display_text_range\":[0,261],\"entities\":{\"urls\":[{\"display_url\":\"developer.x.com\",\"expanded_url\":\"http://developer.x.com\",\"indices\":[238,261],\"url\":\"https://t.co/FS66GuIYJD\"}]},\"favorite_count\":5599,\"favorited\":false,\"full_text\":\"Officially launching X API Pay-Per-Use\\n\\nThe core of X developers are indie builders, early stage products, startups, and hobbyists\\n\\nIt’s time to open up our X API ecosystem and instill a new wave of next generation X apps\\n\\nWe’re so back. https://t.co/FS66GuIYJD\",\"id_str\":\"2019881223666233717\",\"is_quote_status\":false,\"lang\":\"en\",\"possibly_sensitive\":false,\"possibly_sensitive_editable\":true,\"quote_count\":596,\"reply_count\":791,\"retweet_count\":896,\"retweeted\":false,\"user_id_str\":\"2244994945\"},\"quick_promote_eligibility\":{\"eligibility\":\"IneligibleNotVerified\"},\"rest_id\":\"2019881223666233717\",\"unmention_data\":{},\"views\":{\"count\":\"2552260\",\"state\":\"EnabledWithCount\"}}}}},\"entryId\":\"tweet-2019881223666233717\",\"sortIndex\":\"2109014645799911424\"},\"type\":\"TimelinePinEntry\"},{\"entries\":[{\"content\":{\"__typename\":\"TimelineTimelineModule\",\"clientEventInfo\":{\"component\":\"suggest_who_to_follow\",\"details\":{\"timelinesDetails\":{\"controllerData\":\"DAACDAACDAABCgABAAAAAAAAAAgAAAAA\",\"injectionType\":\"WhoToFollow\",\"sourceData\":\"DAABCgABHpf9hY+i4oYKAAIAAAAAAAAAAAAIAAIAAACDCAADAAAAAgwABQwAAgwAAgwAAQoAAQAAAAAAAAAIAAAAAAA=\"}}},\"displayType\":\"Vertical\",\"entryType\":\"TimelineTimelineModule\",\"footer\":{\"displayType\":\"Classic\",\"landingUrl\":{\"url\":\"twitter://connect_people?user_id=2244994945&display_location=profile_wtf_showmore\",\"urlType\":\"DeepLink\"},\"text\":\"Example text.\"},\"header\":{\"displayType\":\"Classic\",\"sticky\":false,\"text\":\"Example text.\"},\"items\":[{\"entryId\":\"who-to-follow-2109014645799911429-user-1000000000000000001\",\"item\":{\"clientEventInfo\":{\"component\":\"suggest_who_to_follow\",\"details\":{\"timelinesDetails\":{\"controllerData\":\"DAACDAACDAABCgABAAAAAAAAAAgAAAAA\",\"injectionType\":\"WhoToFollow\",\"sourceData\":\"DAABCgABHpf9hY+i4oYKAAIAAAAAAAAAAAAIAAIAAACDCAADAAAAAgwABQwAAgwAAgwAAQoAAQAAAAAAAAAIAAAAAAA=\"}},\"element\":\"user\"},\"itemContent\":{\"__typename\":\"TimelineUser\",\"itemType\":\"TimelineUser\",\"userDisplayType\":\"User\",\"user_results\":{\"result\":{\"__typename\":\"User\",\"action_counts\":{\"favorites_count\":3347},\"affiliates_highlighted_label\":{},\"avatar\":{\"image_url\":\"https://pbs.twimg.com/profile_images/1000000000000000000/example_normal.jpg\"},\"banner\":{\"image_url\":\"https://pbs.twimg.com/profile_banners/1000000000000000000/1700000000\"},\"core\":{\"created_at\":\"Wed Apr 15 02:29:52 +0000 2009\",\"name\":\"Example User 1\",\"screen_name\":\"example_user_1\"},\"dm_permissions\":{\"can_dm\":true},\"follow_request_sent\":false,\"has_graduated_access\":true,\"id\":\"VXNlcjoxMDAwMDAwMDAwMDAwMDAwMDAx\",\"is_blue_verified\":true,\"location\":{\"location\":\"\"},\"media_permissions\":{\"can_media_tag\":true},\"notifications_settings\":{\"notifications_enabled\":false},\"parody_commentary_fan_label\":\"None\",\"pinned_items\":{\"tweet_ids_str\":[\"2032073729539260818\"]},\"possibly_sensitive\":false,\"privacy\":{\"protected\":false},\"profile_bio\":{\"description\":\"Example\",\"entities\":{\"description\":{},\"url\":{\"urls\":[{\"display_url\":\"example.com\",\"expanded_url\":\"https://example.com\",\"indices\":[0,23],\"url\":\"https://t.co/example\"}]}}},\"profile_description_language\":\"en\",\"profile_image_shape\":\"Square\",\"profile_metadata\":{\"profile_interstitial_type\":\"\"},\"profile_translation\":{\"translator_type\":\"none\"},\"relationship_counts\":{\"followers\":4099608,\"following\":62},\"relationship_perspectives\":{\"blocked_by\":false,\"blocking\":false,\"followed_by\":false,\"following\":false,\"live_following\":false,\"muting\":false},\"rest_id\":\"1000000000000000001\",\"super_follow_eligible\":false,\"super_followed_by\":false,\"super_following\":false,\"tweet_counts\":{\"media_tweets\":3176,\"tweets\":158866},\"verification\":{\"verified\":false,\"verified_type\":\"Business\"},\"website\":{\"url\":\"https://t.co/example\"}}}}}}]},\"entryId\":\"who-to-follow-2109014645799911429\",\"sortIndex\":\"2109014645799911419\"},{\"content\":{\"__typename\":\"TimelineTimelineCursor\",\"cursorType\":\"Top\",\"entryType\":\"TimelineTimelineCursor\",\"value\":\"DAAHCgABHUS5pXUAJxELAAIAAAATMjEwODk2ODM2MDY5MjQwNDI2MQgAAwAAAAEAAA\"},\"entryId\":\"cursor-top-2109014645799911425\",\"sortIndex\":\"2109014645799911425\"},{\"content\":{\"__typename\":\"TimelineTimelineCursor\",\"cursorType\":\"Bottom\",\"entryType\":\"TimelineTimelineCursor\",\"value\":\"DAAHCgABHUS5pXT__-wLAAIAAAATMjEwMjQ0NzU2NzA0MDgyMzc2MAgAAwAAAAIAAA\"},\"entryId\":\"cursor-bottom-2109014645799911404\",\"sortIndex\":\"2109014645799911404\"}],\"type\":\"TimelineAddEntries\"}]}}}}"
}

In the raw format, field names and nesting come from X and can change without notice. See Response format; the simple format keeps a fixed schema.

Errors

  • 400The body is not valid JSON.
  • 422A required field is missing (including proxy), an ID is not numeric, or the cookie has no ct0. Also: the account is suspended, X rejected the session, or the text was already posted.
  • 407The proxy is unreachable or timed out.
  • X'sAny status X answers with (for example 401, 403, 404): passed through with X's body.

Errors every endpoint can return (401, 402, 403, 404, 408, 409, 429, 5xx), and which of them are charged, are on the Errors page. Calls that fail with 400, 408, 409 or a 5xx error are refunded.