List message requests

Parameters

• cookiebody · string · required

  Cookie header of your own logged-in X session. Must contain auth_token, ct0 and twid (your account ID, set by x.com at login); 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.

• passcodebody · string · optional

  Your X Chat passcode, the one you set up for encrypted messages on X. Without it the conversations are listed without messages. Send it as a string (a number works too, but loses leading zeros), up to 64 characters. It unlocks your chat keys for this request and is not saved. The unlocked keys stay in the server's memory for up to 30 minutes, so follow-up calls need no new unlock.

• folderbody · string · optional

  you_may_know or other (the Other tab under Requests on X). Without it both folders are returned.

• countbody · integer · optional · default 20

  Requests per folder, 1 to 50.

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

Notes

• The passcode errors only occur when a passcode is sent.
• The cookie and proxy fields: Your X session (cookie).

Example request

curl -X POST 'https://api.twittrapi.com/client/dm/requests' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"cookie":"auth_token=...; ct0=...; twid=u%3D...","proxy":"http://user:pass@host:port","folder":"other","count":20}'

import httpx

resp = httpx.post(
    "https://api.twittrapi.com/client/dm/requests",
    headers={"X-API-KEY": "YOUR_API_KEY"},
    json={
        "cookie": "auth_token=...; ct0=...; twid=u%3D...",
        "proxy": "http://user:pass@host:port",
        "folder": "other",
        "count": 20,
    },
    timeout=60,
)
print(resp.status_code, resp.json())

const resp = await fetch("https://api.twittrapi.com/client/dm/requests", {
  method: "POST",
  headers: { "X-API-KEY": process.env.TWITTRAPI_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    cookie: "auth_token=...; ct0=...; twid=u%3D...",
    proxy: "http://user:pass@host:port",
    folder: "other",
    count: 20,
  }),
});
console.log(resp.status, await resp.json());

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

{requests: [{conversation_id, type, folder, participants, messages, undecrypted, decrypt_error}], total_count, has_more, decrypted}. messages holds the latest ones, newest first; older ones come from /client/dm/conversation with the passcode. has_more is true when X has more requests than returned.

Simple format (?format=simple or X-Response-Format: simple): Collection without cursors: {data: [{id, type, folder, participants, lastMessage, messages}], hasNextPage}. Message objects {id, senderId, createdAt, expiresAt, type, text, emoji, targetId, replyTo {id, senderId, text}, attachments [{kind, type, filename, filesizeBytes, durationMs, width, height, url, mediaHashKey}], verified}; times are RFC 3339, unknown values null Schema.

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.
• 422cookie or proxy is missing, the cookie has no twid or ct0, or the passcode is neither a string nor a whole number or longer than 64 characters. count is not a number from 1 to 50, or folder is not you_may_know or other. Also: the account is suspended, or X rejected the session ("Twitter temporarily rejected this session; refresh the login and try again").
• 407The proxy is unreachable or timed out.
• 422Wrong passcode: "Wrong passcode (N attempts left before X deletes the chat keys)". X deletes the chat keys after too many wrong passcodes, so the API never sends the same wrong passcode to X twice (for 24 hours it answers 422 at once), and once only 3 attempts are left it does not try at all: "Only a few passcode attempts are left for this account; unlock Chat in the X app with the correct passcode first".
• 422The account has no chat passcode yet: open Chat on x.com once and set one up.
• 501Encrypted messages are not available on this server (the passcode cannot be used). Refunded.
• 502The chat keys could not be unlocked ("Could not unlock the chat keys, try again") or the messages could not be decrypted. Refunded.
• 429X's rate limit for this account: "X rate limit reached for this account, try again later".
• X'sX refused the request: answered with X's status and {"error": "X refused the request: <X's reason>"}. When X answers 200 with an error, the status is 422.

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, 407, 408, 409 or a 5xx error are refunded.