List members: GET /lists/members

Docs

List members

Accounts that are members of a list.

GET/lists/members

Parameters

listIdquery · string · required
Numeric list ID, the number in the list URL (x.com/i/lists/<listId>).
countquery · integer · optional · default 20
Number of members to ask X for. Sent to X as is; X treats it as a hint and decides how many it returns (follower and following pages often hold 50 to 70 users for count=20). A value that is not a number falls back to 20.
cursorquery · string · optional
Bottom cursor from the previous page. Leave it out for the first page. See Pagination.

Name	In	Type	Required	Default	Description
listId	query	string	yes		Numeric list ID, the number in the list URL (x.com/i/lists/<listId>).
count	query	integer	no	20	Number of members to ask X for. Sent to X as is; X treats it as a hint and decides how many it returns (follower and following pages often hold 50 to 70 users for count=20). A value that is not a number falls back to 20.
cursor	query	string	no		Bottom cursor from the previous page. Leave it out for the first page. See Pagination.

Paginated: pass the bottom cursor of one page as cursor to get the next. Each page is one billed call. See Pagination.

Example request

curl 'https://api.twittrapi.com/lists/members?listId=84839422' \
  --header 'X-API-KEY: YOUR_API_KEY'

from twittrapi import TwittrAPI

client = TwittrAPI(api_key="YOUR_API_KEY")
data = client.lists.members("84839422")

import { TwittrAPI } from "twittrapi";

const client = new TwittrAPI({ apiKey: process.env.TWITTRAPI_API_KEY });
const data = await client.lists.members({ listId: "84839422" });

curl 'https://twitter-aio.p.rapidapi.com/lists/members?listId=84839422' \
  --header 'x-rapidapi-key: YOUR_RAPIDAPI_KEY' \
  --header 'x-rapidapi-host: twitter-aio.p.rapidapi.com'

Base URL https://api.twittrapi.com, key in the X-API-KEY header. Python and Node.js use the official SDKs.

Response

Raw JSON of X's ListMembers query.

Simple format (?format=simple or X-Response-Format: simple): Collection of User objects: {data: [User], nextCursor, previousCursor, hasNextPage}. Schema.

{
  "data": {
    "list": {
      "members_timeline": {
        "timeline": {
          "instructions": [
            {
              "type": "TimelineClearCache"
            },
            {
              "direction": "Top",
              "type": "TimelineTerminateTimeline"
            },
            {
              "entries": [
                {
                  "content": {
                    "__typename": "TimelineTimelineItem",
                    "clientEventInfo": {
                      "component": "MembersSgs",
                      "element": "user"
                    },
                    "entryType": "TimelineTimelineItem",
                    "itemContent": {
                      "__typename": "TimelineUser",
                      "itemType": "TimelineUser",
                      "userDisplayType": "User",
                      "user_results": {
                        "result": {
                          "__typename": "User",
                          "affiliates_highlighted_label": {},
                          "avatar": {
                            "image_url": "https://pbs.twimg.com/profile_images/1354486384329854984/BXv7J1j2_normal.jpg"
                          },
                          "core": {
                            "created_at": "Mon Mar 30 21:02:29 +0000 2020",
                            "name": "Twitter Thailand",
                            "screen_name": "TwitterThailand"
                          },
                          "dm_permissions": {
                            "can_dm": false
                          },
                          "follow_request_sent": false,
                          "has_graduated_access": true,
                          "id": "VXNlcjoxMjQ0NzMxNDkxMDg4ODA5OTg0",
                          "is_blue_verified": false,
                          "legacy": {
                            "default_profile": true,
                            "default_profile_image": false,
                            "description": "Please follow @X for updates.",
                            "entities": {
                              "description": {}
                            },
                            "fast_followers_count": 0,
                            "favourites_count": 16,
                            "follow_request_sent": false,
                            "followers_count": 37828,
                            "friends_count": 16,
                            "has_custom_timelines": true,
                            "is_translator": false,
                            "listed_count": 39,
                            "media_count": 333,
                            "needs_phone_verification": false,
                            "normal_followers_count": 37828,
                            "notifications": false,
                            "pinned_tweet_ids_str": [
                              "1580793959307436032"
                            ],
                            "possibly_sensitive": false,
                            "profile_banner_url": "https://pbs.twimg.com/profile_banners/1244731491088809984/1611791443",
                            "profile_interstitial_type": "",
                            "statuses_count": 1263,
                            "time_zone": "",
                            "translator_type": "none",
                            "url": "",
                            "utc_offset": 0,
                            "want_retweets": false,
                            "withheld_description": "",
                            "withheld_scope": ""
                          },
                          "location": {
                            "location": ""
                          },
                          "media_permissions": {
                            "can_media_tag": false
                          },
                          "parody_commentary_fan_label": "None",
                          "privacy": {
                            "protected": true
                          },
                          "profile_bio": {
                            "description": "Please follow @X for updates."
                          },
                          "profile_description_language": "en",
                          "profile_image_shape": "Circle",
                          "relationship_perspectives": {
                            "blocked_by": false,
                            "blocking": false,
                            "followed_by": false,
                            "following": false,
                            "muting": false
                          },
                          "rest_id": "1244731491088809984",
                          "super_follow_eligible": false,
                          "super_followed_by": false,
                          "super_following": false,
                          "verification": {
                            "verified": false
                          }
                        }
                      }
                    }
                  },
                  "entryId": "user-1244731491088809984",
                  "sortIndex": "2109016359324090367"
                },
                {
                  "content": {
                    "__typename": "TimelineTimelineItem",
                    "clientEventInfo": {
                      "component": "MembersSgs",
                      "element": "user"
                    },
                    "entryType": "TimelineTimelineItem",
                    "itemContent": {
                      "__typename": "TimelineUser",
                      "itemType": "TimelineUser",
                      "userDisplayType": "User",
                      "user_results": {
                        "result": {
                          "__typename": "User",
                          "affiliates_highlighted_label": {},
                          "avatar": {
                            "image_url": "https://pbs.twimg.com/profile_images/1580568780828250114/QNLIImWZ_normal.jpg"
                          },
                          "core": {
                            "created_at": "Tue Sep 03 19:59:02 +0000 2019",
                            "name": "Twitter Able",
                            "screen_name": "TwitterAble"
                          },
                          "dm_permissions": {
                            "can_dm": false
                          },
                          "follow_request_sent": false,
                          "has_graduated_access": true,
                          "id": "VXNlcjoxMTY4OTc2NjgwODY3NzYyMTc3",
                          "is_blue_verified": false,
                          "legacy": {
                            "default_profile": true,
                            "default_profile_image": false,
                            "description": "Please follow @X for updates.",
                            "entities": {
                              "description": {}
                            },
                            "fast_followers_count": 0,
                            "favourites_count": 504,
                            "follow_request_sent": false,
                            "followers_count": 9423,
                            "friends_count": 79,
                            "has_custom_timelines": true,
                            "is_translator": false,
                            "listed_count": 167,
                            "media_count": 20,
                            "needs_phone_verification": false,
                            "normal_followers_count": 9423,
                            "notifications": false,
                            "pinned_tweet_ids_str": [
                              "1580570198612250625"
                            ],
                            "possibly_sensitive": false,
                            "profile_banner_url": "https://pbs.twimg.com/profile_banners/1168976680867762177/1665671940",
                            "profile_interstitial_type": "",
                            "statuses_count": 226,
                            "time_zone": "",
                            "translator_type": "none",
                            "url": "",
                            "utc_offset": 0,
                            "want_retweets": false,
                            "withheld_description": "",
                            "withheld_scope": ""
                          },
                          "location": {
                            "location": ""
                          },
                          "media_permissions": {
                            "can_media_tag": false
                          },
                          "parody_commentary_fan_label": "None",
                          "privacy": {
                            "protected": true
                          },
                          "profile_bio": {
                            "description": "Please follow @X for updates."
                          },
                          "profile_description_language": "en",
                          "profile_image_shape": "Circle",
                          "relationship_perspectives": {
                            "blocked_by": false,
                            "blocking": false,
                            "followed_by": false,
                            "following": false,
                            "muting": false
                          },
                          "rest_id": "1168976680867762177",
                          "super_follow_eligible": false,
                          "super_followed_by": false,
                          "super_following": false,
                          "verification": {
                            "verified": false
                          }
                        }
                      }
                    }
                  },
                  "entryId": "user-1168976680867762177",
                  "sortIndex": "2109016359324090366"
                },
                {
                  "content": {
                    "__typename": "TimelineTimelineCursor",
                    "cursorType": "Bottom",
                    "entryType": "TimelineTimelineCursor",
                    "value": "1000000000000000000|2109016359324090346"
                  },
                  "entryId": "cursor-bottom-2109016359324090348",
                  "sortIndex": "2109016359324090348"
                },
                {
                  "content": {
                    "__typename": "TimelineTimelineCursor",
                    "cursorType": "Top",
                    "entryType": "TimelineTimelineCursor",
                    "value": "-1|2109016359324090369"
                  },
                  "entryId": "cursor-top-2109016359324090369",
                  "sortIndex": "2109016359324090369"
                }
              ],
              "type": "TimelineAddEntries"
            }
          ]
        }
      }
    }
  }
}

{
  "data": [
    {
      "id": "1244731491088809984",
      "username": "TwitterThailand",
      "name": "Twitter Thailand",
      "description": "Please follow @X for updates.",
      "location": "",
      "url": null,
      "createdAt": "2020-03-30T21:02:29Z",
      "avatarUrl": "https://pbs.twimg.com/profile_images/1354486384329854984/BXv7J1j2.jpg",
      "bannerUrl": "https://pbs.twimg.com/profile_banners/1244731491088809984/1611791443",
      "verified": false,
      "verifiedType": null,
      "protected": true,
      "counts": {
        "followers": 37828,
        "following": 16,
        "tweets": 1263,
        "likes": 16,
        "media": 333,
        "listed": 39
      },
      "pinnedTweetIds": [
        "1580793959307436032"
      ],
      "isAutomated": false
    },
    {
      "id": "1168976680867762177",
      "username": "TwitterAble",
      "name": "Twitter Able",
      "description": "Please follow @X for updates.",
      "location": "",
      "url": null,
      "createdAt": "2019-09-03T19:59:02Z",
      "avatarUrl": "https://pbs.twimg.com/profile_images/1580568780828250114/QNLIImWZ.jpg",
      "bannerUrl": "https://pbs.twimg.com/profile_banners/1168976680867762177/1665671940",
      "verified": false,
      "verifiedType": null,
      "protected": true,
      "counts": {
        "followers": 9423,
        "following": 79,
        "tweets": 226,
        "likes": 504,
        "media": 20,
        "listed": 167
      },
      "pinnedTweetIds": [
        "1580570198612250625"
      ],
      "isAutomated": false
    }
  ],
  "nextCursor": "1000000000000000000|2109016359324090346",
  "previousCursor": null,
  "hasNextPage": true
}

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

400listId is missing or not numeric.

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.