Lists

Get an X List's name, description, counts and owner

Changed on

Returns 1 public X List as its page on X shows it. Accepts the List ID or the URL-encoded List URL, such as x.com/i/lists/4143408. A private List answers 404 list_not_found.

get/x/lists/{id}

Request

  • Base URL: https://xquik.com/api/v1
  • URL: https://xquik.com/api/v1/x/lists/{id}
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • none

Path parameters

idstring required

X List ID, or the URL-encoded List link, such as x.com/i/lists/4143408.

Query parameters

fieldsstring
Example:id,text,author.username

Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it.

omitstring
Example:entities,media

Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.

Response

List details

Example response

{
  "list": {
    "id": "4143408",
    "name": "NASA Centers",
    "description": "NASA has 10 centers http://www.nasa.gov/about/sites",
    "memberCount": 11,
    "subscriberCount": 859,
    "owner": {
      "id": "11348282",
      "username": "NASA",
      "name": "NASA",
      "followers": 92379503,
      "following": 115,
      "verified": true,
      "isBlueVerified": true,
      "isVerified": true,
      "profilePicture": "https://pbs.twimg.com/profile_images/1321163587679784960/0ZxKlEKB_normal.jpg",
      "coverPicture": "https://pbs.twimg.com/profile_banners/11348282/1788992290",
      "profileBannerUrl": "https://pbs.twimg.com/profile_banners/11348282/1788992290",
      "description": "Making the seemingly impossible, possible. ✨",
      "location": "Pale Blue Dot",
      "createdAt": "Wed Dec 19 20:20:32 +0000 2007",
      "statusesCount": 74372,
      "mediaCount": 28176,
      "protected": false,
      "url": "http://www.nasa.gov/",
      "favouritesCount": 17012,
      "possiblySensitive": false,
      "verifiedType": "Government",
      "profile_bio": {
        "description": "Making the seemingly impossible, possible. ✨",
        "entities": {
          "description": {},
          "url": {
            "urls": [
              {
                "display_url": "nasa.gov",
                "expanded_url": "http://www.nasa.gov/",
                "indices": [
                  0,
                  23
                ],
                "url": "https://t.co/9NkQJKAnuU"
              }
            ]
          }
        }
      },
      "hasGraduatedAccess": true,
      "parodyCommentaryFanLabel": "None",
      "profileDescriptionLanguage": "en",
      "profileImageShape": "Square",
      "profileTranslatorType": "regular",
      "superFollowEligible": false
    },
    "url": "https://x.com/i/lists/4143408",
    "createdAt": "2009-12-02T22:41:02.000Z",
    "defaultBanner": {
      "height": 375,
      "salientRect": {
        "height": 1,
        "left": 562,
        "top": 187,
        "width": 1
      },
      "url": "https://pbs.twimg.com/media/GkIOx3HW4AAHAs6.png",
      "width": 1125
    },
    "membersContext": "11 members"
  }
}

Changes

    • warning

      added the new topup_in_progress enum value to the ///// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the /////// response property for the response status

    • breaking

      added to the response body oneOf list for the response status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property const value Ask the user to confirm a payment option before creating checkout. was added for the status

    • info

      removed the Ask the user to confirm a payment option before creating checkout. enum value from the //// response property for the response status

    • info

      removed the Ask the user to top up at /dashboard/account. This key cannot open checkout. enum value from the //// response property for the response status