user-model.md

UserModel

Example Usage

import { UserModel } from "@twexapi-dev/x-api-scraper/models";

let value: UserModel = {
  id: "1717001045992251392",
  name: "Cryptoklepto",
  screenName: "CK_Cryptoklepto",
  createdAt: "Mon Oct 28 02:32:47 +0000 2024",
  createdAtDatetime: "2024-10-28T02:32:47.000Z",
  urls: [
    {
      url: "https://www.google.com",
      expandedUrl: "https://www.google.com",
      displayUrl: "www.google.com",
    },
  ],
  verifiedType: "government",
  profileImageShape: "Circle",
  location: "New York, USA",
};

Fields

Field	Type	Required	Description	Example
id	string	✔️	User ID	1717001045992251392
name	string	✔️	Display name	Cryptoklepto
screenName	string	✔️	Twitter username	CK_Cryptoklepto
createdAt	string	➖	Account creation date	Mon Oct 28 02:32:47 +0000 2024
createdAtDatetime	string	➖	Account creation datetime in ISO format	2024-10-28T02:32:47.000Z
canDm	boolean	➖	Whether the user can be direct messaged
canMediaTag	boolean	➖	Whether the user can be tagged in media
defaultProfile	boolean	➖	Whether the user has a default profile
defaultProfileImage	boolean	➖	Whether the user has a default profile image
description	string	➖	User's bio description
descriptionUrls	string[]	➖	List of URLs found in the user's description
urls	models.UrlModel[]	➖	List of URLs found in the user's profile
fastFollowersCount	number	➖	Count of fast followers
favouritesCount	number	➖	Number of tweets the user has liked
followersCount	number	➖	Number of followers
followingCount	number	➖	Number of users this user is following
hasCustomTimelines	boolean	➖	Whether the user has custom timelines
isBlueVerified	boolean	➖	Blue verification status
verifiedType	string	➖	Verification badge type when not blue-only: blue, business, government, etc.	Example 1: government Example 2: business Example 3: blue
isVerified	boolean	➖	True if the account has any verification badge (blue, business, government, or legacy verified)
profileImageShape	string	➖	Profile image shape (Circle or Square; Square often indicates business/government)	Example 1: Circle Example 2: Square
isTranslator	boolean	➖	Whether the user is a translator
listedCount	number	➖	Number of public lists the user is a member of
location	string	➖	User's location	New York, USA
mediaCount	number	➖	Number of media tweets posted by the user
normalFollowersCount	number	➖	Count of normal followers
pinnedTweetIds	string[]	➖	List of pinned tweet IDs
possiblySensitive	boolean	➖	Whether the user's profile may contain sensitive content
profileBannerUrl	string	➖	URL of the user's profile banner
profileImageUrl	string	➖	URL of the user's profile image
protected	boolean	➖	Whether the user's tweets are protected
statusesCount	number	➖	Number of tweets posted by the user