Social

X/Twitter Inbox

Read a connected X/Twitter account's private surfaces: bookmarks and bookmark folders, notifications, and DM history. Billed per item returned; readable only for handles this wallet connected.

post/api/tools/x_inbox

Request

  • Base URL: https://twitr.sh
  • URL: https://twitr.sh/api/tools/x_inbox
  • Auth: none declared

Request body

action'bookmarks' | 'bookmark_folders' | 'notifications' | 'dm_history' required

Which inbox read to run.

accountstring required

A connected X handle owned by this wallet (no @).

resultsLimitinteger

Max items to return (billed per item); ignored for bookmark_folders.

folderIdstring

bookmarks: optional folder to read.

typestring

notifications: optional filter (e.g. mentions).

target_user_idstring

dm_history: the other party's user id.

maxIdstring

dm_history: paginate before this message id.

Response

Result dataset.

itemsobject[] required

Array of returned items. Shape varies per tool — see each tool's documentation.

runIdstring

Run ID for debugging/audit.

durationinteger

Run duration in seconds.

Changes

No recorded changes to this operation across all 1 revision of this API.