Users¶

Indicates that the user has an account with “contributor mode” enabled, allowing for Tweets issued by the user to be co-authored by another account. Rarely true (this is a legacy field) Example:

"contributors_enabled": false

When true, indicates that the user has not altered the theme or background of their user profile. Example:

"default_profile": false

Nullable . The user-defined UTF-8 string describing their account. Example:

"description": "The Real Twitter API."

The number of Tweets this user has liked in the account’s lifetime. British spelling used in the field name for historical reasons. Example:

"favourites_count": 13

Nullable . Perspectival . Deprecated. When true, indicates that the authenticating user is following this user. Some false negatives are possible when set to “false,” but these false negatives are increasingly being represented as “null” instead. See Discussion . Example:

"following": true

The number of users this account is following (AKA their “followings”). Under certain conditions of duress, this field will temporarily indicate “0”. Example:

"friends_count": 32

The integer representation of the unique identifier for this User. This number is greater than 53 bits and some programming languages may have difficulty/silent defects in interpreting it. Using a signed 64 bit integer for storing this identifier is safe. Use id_str for fetching the identifier to stay on the safe side. See Twitter IDs, JSON and Snowflake . Example:

"id": 6253282

When true, indicates that the user is a participant in Twitter’s translator community . Example:

"is_translator": false

The number of public lists that this user is a member of. Example:

"listed_count": 9274

The name of the user, as they’ve defined it. Not necessarily a person’s name. Typically capped at 20 characters, but subject to change. Example:

"name": "Twitter API"

The hexadecimal color chosen by the user for their background. Example:

"profile_background_color": "e8f2f7"

profile_background_

image_url_https

A HTTPS-based URL pointing to the background image the user has uploaded for their profile. Example:

"profile_background_image_url_https":
"https://si0.twimg.com/profile_background_images/229557229/twitterapi-bg.png"

The HTTPS-based URL pointing to the standard web representation of the user’s uploaded profile banner. By adding a final path element of the URL, it is possible to obtain different image sizes optimized for specific displays. For size variants, please see User Profile Images and Banners .

Example:

"profile_banner_url": "https://si0.twimg.com/profile_banners/819797/1348102824"

A HTTPS-based URL pointing to the user’s profile image. Example:

"profile_image_url_https":
"https://abs.twimg.com/sticky/default_profile_images/default_profile_normal.png"

The hexadecimal color the user has chosen to display sidebar borders with in their Twitter UI. Example:

"profile_sidebar_border_color": "0094C2"

The hexadecimal color the user has chosen to display text with in their Twitter UI. Example:

"profile_text_color": "437792"

When true, indicates that this user has chosen to protect their Tweets. See About Public and Protected Tweets . Example:

"protected": true

Nullable . If possible, the user’s most recent Tweet or retweet. In some circumstances, this data cannot be provided and this field will be omitted, null, or empty. Perspectival attributes within Tweets embedded within users cannot always be relied upon. Example:

"status": {
    "coordinates": null,
    "favorited": false,
    "truncated": false,
    "created_at": "Tue Apr 17 16:38:18 +0000 2012",
    "id_str": "192290904646754304",
    "entities": {
      "urls": [

      ],
      "hashtags": [

      ],
      "user_mentions": [
        {
          "name": "Micah McVicker",
          "id_str": "166661446",
          "id": 166661446,
          "indices": [
            0,
            14
          ],
          "screen_name": "MicahMcVicker"
        }
      ]
    },
    "in_reply_to_user_id_str": "166661446",
    "contributors": null,
    "text": "@MicahMcVicker make sure you're using include_rts=true and no other filters..."
    "retweet_count": 0,
    "in_reply_to_status_id_str": "192290470427246594",
    "id": 192290904646754304,
    "geo": null,
    "retweeted": false,
    "in_reply_to_user_id": 166661446,
    "place": null,
    "in_reply_to_screen_name": "MicahMcVicker",
    "source": "YoruFukurou",
    "in_reply_to_status_id": 192290470427246594
 },

Nullable . A string describing the Time Zone this user declares themselves within. Example:

"time_zone": "Pacific Time (US & Canada)"

Nullable . The offset from GMT/UTC in seconds. Example:

"utc_offset": -18000

When present, indicates a textual representation of the two-letter country codes this user is withheld from. Example:

"withheld_in_countries": "GR, HK, MY"