Users

Learn the structure of a user object on VtubersTV.

References

User Object

idString
The unique identifier of the user. This is a string that is unique to the user and is used to identify the user in the database. This is not to be confused with _id which is the unique document identifier in the database.
usernameString
The username of the user. This is the username that the user uses to log in to VtubersTV. This is unique to the user and is used to identify the user on the platform.
emailString | undefined
The email of the user. This is only available if the requesting user is the same as the user being requested.
passwordString | undefined
The password of the user. This is only available if the requesting user is the same as the user being requested. This is used to identify the user's password. This is a hashed password and salted that is used to secure the user's account.
followersString<ObjectId>[]
The list of followers of the user. This is a list of the unique identifiers of the users that are following the user.
followingString<ObjectId>[]
The list of users that the user is following. This is a list of the unique identifiers of the users that the user is following.
watch_historyString[] | undefined
The list of videos that the user has watched. This is a list of the unique identifiers of the videos that the user has watched.
total_viewsInt32
The total number of views that the user has received. This is the total number of views that the user has received on the platform. This only includes views that the user has received on their videos.
avatarString
The avatar of the user. This is the image that is used to represent the user on the platform. This is a URL that points to the image that is used as the user's avatar.
birthdayString | undefined
The birthday of the user. This is the birthday of the user in the format MM/DD/YYYY. This is only available if the requesting user is the same as the user being requested.
display_nameString
The display name of the user. This is the name that is displayed to other users on the platform.
pronounsString
The pronouns of the user. This is the pronouns that the user uses to identify themselves. The data comes from data.vtubers.tv
bannerString
The banner of the user. This is the image that is used to represent the user on the platform. This is a URL that points to the image that is used as the user's banner.
bioString
The bio of the user. This is a short description or biography that the user provides to tell others about themselves.
is_bannedBoolean
Indicates whether the user is banned from the platform. This is a boolean value that determines if the user is currently banned from accessing the platform.
warningsString<ObjectId>[]
The list of warnings issued to the user. This is a list of the unique identifiers of the warnings that have been issued to the user.
roleString
The role of the user on the platform. This could be 'user', 'admin', 'moderator', etc., and determines the user's permissions on the platform.
videosString<ObjectId>[]
The list of videos uploaded by the user. This is a list of the unique identifiers of the videos that the user has uploaded.
watch_laterString<ObjectId>[] | undefined
The list of videos that the user has marked to watch later. This is a list of the unique identifiers of the videos that the user intends to watch later.
socialsString[]
The list of social media links associated with the user. This is a list of URLs that link to the user's social media profiles.
disliked_videosString<ObjectId>[] | undefined
The list of videos that the user has disliked. This is a list of the unique identifiers of the videos that the user has disliked.
liked_videosString<ObjectId>[] | undefined
The list of videos that the user has liked. This is a list of the unique identifiers of the videos that the user has liked.
ip_addressesString[] | undefined
The list of IP addresses associated with the user. This is only available if the requesting user is the same as the user being requested.
tokenString | undefined
The authentication token of the user. This is only available if the requesting user is the same as the user being requested. This token is used to authenticate the user on the platform.
latest_videosString<ObjectId>[]
The list of the user's latest uploaded videos. This is a list of the unique identifiers of the most recently uploaded videos by the user.
popular_videosString<ObjectId>[]
The list of the user's most popular videos. This is a list of the unique identifiers of the videos that have the most views or engagement.
created_atString
The timestamp when the user was created. This is the date and time when the user's account was created in the format YYYY-MM-DDTHH:MM:SSZ.
_idString
The MongoDB ObjectId of the user document. This is the unique document identifier in the database.
__v.resultString
The result of the version key. This is a formatted number that represents the version of the document.
can_be_editedBoolean
Indicates whether the user's profile can be edited by the user. This is a boolean value that determines if the user is allowed to make changes to their profile.
filed_reportsArray<Object>
The list of reports filed by the user. Each report contains information about the report's ID, category, subcategory, more information, reporter, autoMessage, resolution status, resolver, resolved_at timestamp, events, and the created_at timestamp.
safety_rulesObject
The safety rules associated with the user. This object contains the rule ID, name, regex pattern, action, status, created_at timestamp, updated_at timestamp, and notes.
notificationsArray<Object>
The list of notifications received by the user. Each notification contains the notification ID, type, message, data (including image, title, message, timestamp), and the created_at timestamp.
premiumObject
The premium membership status of the user. This object contains information about whether the user is a premium member, the date since they became a premium member, the expiration date of the premium membership, and the Stripe customer ID.
applicationsArray<Object>
The list of applications authorized by the user. Each application contains the application ID, name, permissions, and the created_at timestamp.
vanityObject
The vanity URL of the user. This object contains the custom URL and username chosen by the user for their profile.
Videos
Learn how to get a video on VtubersTV.
Videos
Learn the structure of a video object on VtubersTV.