Twitter User Tweets

twitter_user_tweets

Fetch a page of a user's timeline (tweets / tweets+replies / media-only) with cursor pagination

Category: twitter•Timeout: 300s• Retryable

Input schema

POST this shape to /api/v1/tasks as the input field when creating a task in a group of type twitter_user_tweets.

{
  "type": "object",
  "properties": {
    "screenName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 15,
      "pattern": "^[A-Za-z0-9_]{1,15}$",
      "description": "X handle without the @ prefix"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200,
      "description": "Maximum items per page (1–200)"
    },
    "tab": {
      "type": "string",
      "enum": [
        "tweets",
        "replies",
        "media"
      ],
      "description": "Timeline kind: tweets = posts only, replies = posts + replies, media = only tweets with photo/video"
    },
    "cursor": {
      "type": "string",
      "description": "Opaque cursor from a previous response's nextCursor; omit for the first page"
    },
    "includePinned": {
      "type": "boolean",
      "description": "Whether to include the user's pinned tweet at the head of the first page (default true)"
    }
  },
  "required": [
    "screenName",
    "limit",
    "tab"
  ]
}

Output schema

Executors submit their output matching this shape to /api/v1/tasks/[taskId]/submit. Readers pull it back from task detail endpoints.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "user": {
          "type": [
            "object",
            "null"
          ],
          "description": "Minimal user — returned only on the first page",
          "properties": {
            "restId": {
              "type": "string"
            },
            "screenName": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "isVerified": {
              "type": "boolean"
            },
            "isBlueVerified": {
              "type": "boolean"
            },
            "profileImageUrl": {
              "type": "string"
            }
          }
        },
        "tweets": {
          "type": "array",
          "description": "Each item has the same shape as twitter_tweet_details.data",
          "items": {
            "type": "object"
          }
        },
        "nextCursor": {
          "type": [
            "string",
            "null"
          ]
        },
        "hasMore": {
          "type": "boolean"
        }
      }
    }
  },
  "required": [
    "url",
    "data"
  ]
}

Ready to run Twitter User Tweets?

Create a project, approve an executor, and push your first twitter_user_tweets task.

Get started