Twitter User Followers

twitter_user_followers

Fetch a page of a user's followers, following, or verified followers 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_followers.

{
  "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 users per page (1–200)"
    },
    "relation": {
      "type": "string",
      "enum": [
        "followers",
        "following",
        "verified_followers"
      ],
      "description": "followers = users who follow the target; following = users the target follows; verified_followers = X Premium followers"
    },
    "cursor": {
      "type": "string",
      "description": "Opaque cursor from a previous response's nextCursor; omit for the first page"
    }
  },
  "required": [
    "screenName",
    "limit",
    "relation"
  ]
}

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": {
        "users": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "restId": {
                "type": "string"
              },
              "screenName": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "location": {
                "type": "string"
              },
              "url": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "followersCount": {
                "type": "integer"
              },
              "followingCount": {
                "type": "integer"
              },
              "tweetCount": {
                "type": "integer"
              },
              "isVerified": {
                "type": "boolean"
              },
              "isBlueVerified": {
                "type": "boolean"
              },
              "isProtected": {
                "type": "boolean"
              },
              "profileImageUrl": {
                "type": "string"
              }
            }
          }
        },
        "nextCursor": {
          "type": [
            "string",
            "null"
          ]
        },
        "hasMore": {
          "type": "boolean"
        }
      }
    }
  },
  "required": [
    "url",
    "data"
  ]
}

Ready to run Twitter User Followers?

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

Get started