WeverseClient¶

Clients¶

WeverseClientSync¶

WeverseClientAsync¶

Models¶

Community¶

class Weverse.models.Community(**kwargs)¶

A Community object that represents a Weverse Community.

It is not suggested to create a Community manually, but rather through the following method: Weverse.objects.create_community_objects

The information retrieved on a Community is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Communities have the same ID.

x != y: Checks if two Communities do not have the same ID.

str(x): Returns the Community’s name.

Parameters

id (int) – The Community ID.
name (str) – The Community Name.
description (str) – Description of the Community.
member_count (int) – Amount of members in the community.
home_banner (str) – Direct Image URL to the home banner.
icon (str) – Direct Image URL to the Icon.
Banner (str) – Direct Image URL to the Banner.
full_name (str) – Full Name of the Community.
fc_member (bool) – If a special membership is required to join.
show_member_count (bool) – If the member count is visible.

id¶

The Community ID.

Type: int

name¶

The Community Name.

Type: str

description¶

Description of the Community.

Type: str

member_count¶

Amount of members in the community.

Type: int

home_banner¶

Direct Image URL to the home banner.

Type: str

icon¶

Direct Image URL to the Icon.

Type: str

Banner¶

Direct Image URL to the Banner.

Type: str

full_name¶

Full Name of the Community.

Type: str

fc_member¶

If a special membership is required to join.

Type: bool

show_member_count¶

If the member count is visible.

Type: bool

artists¶

List of artists the community has.

Type: List[Artist]

tabs¶

The Tabs the community has.

Type: List[Tab]

Notification¶

class Weverse.models.Notification(**kwargs)¶

A Media object that represents a Weverse Media Post.

It is not suggested to create a Notification object manually, but rather through the following method: Weverse.objects.create_notification_objects

The information retrieved on a Notification is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Notifications have the same ID.

x != y: Checks if two Notifications do not have the same ID.

Parameters

id (int) – The id of the notification.
message (str) – The message of the notification.
bold_element (str) – The bolded element in the notification.
community_id (int) – The community id associated with the notification.
community_name (str) – The community name associated with the notification.
contents_type (str) – The type of post it is.
contents_id (int) – The id of the content post.
notified_at – The time the notification was triggered.
icon_image_url (str) – Icon image url of the notification.
thumbnail_image_url (str) – Thumbnail url of the notification.
artist_id (int) – The ID of the Artist that released the content.
is_membership_content (bool) – If the content is exclusive to members.
is_web_only (bool) – Whether the notification is only available directly on the website.
platform (str) – The platform of the notification.

id¶

The id of the notification.

Type: int

message¶

The message of the notification.

Type: str

bold_element¶

The bolded element in the notification.

Type: str

community_id¶

The community id associated with the notification.

Type: int

community_name¶

The community name associated with the notification.

Type: str

contents_type¶

The type of post it is.

Type: str

contents_id¶

The id of the content post.

Type: int

notified_at¶: The time the notification was triggered.

icon_image_url¶

Icon image url of the notification.

Type: str

thumbnail_image_url¶

Thumbnail url of the notification.

Type: str

artist_id¶

The ID of the Artist that released the content.

Type: int

is_membership_content¶

If the content is exclusive to members.

Type: bool

is_web_only¶

Whether the notification is only available directly on the website.

Type: bool

platform¶

The platform of the notification.

Type: str

Photo¶

class Weverse.models.Photo(**kwargs)¶

A Photo object that represents a Weverse Photo that belongs to media or a post.

It is not suggested to create a Photo manually, but rather through the following method: Weverse.objects.create_photo_objects

The information retrieved on a Photo is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Photo objects have the same ID.

x != y: Checks if two Photo objects do not have the same ID.

str(x): Returns the file name.

Parameters

id (int) – The ID of the photo.
content_index (int) – Index the photo is in from a bundle of photos.
thumbnail_img_url (str) – The thumbnail image link.
thumbnail_img_width (str) – The original image width.
thumbnail_img_height (str) – The thumbnail image height.
original_img_url (str) – The original image link.
original_img_width (str) – The original image width.
original_img_height (str) – The original image height.
file_name (str) – File name of the photo.

id¶

The ID of the photo.

Type: int

media_id¶

The media ID of the photo (if there is one).

Type: Optional[int]

content_index¶

Index the photo is in from a bundle of photos.

Type: int

thumbnail_img_url¶

The thumbnail image link.

Type: str

thumbnail_img_width¶

The original image width.

Type: str

thumbnail_img_height¶

The thumbnail image height.

Type: str

original_img_url¶

The original image link.

Type: str

original_img_width¶

The original image width.

Type: str

original_img_height¶

The original image height.

Type: str

file_name¶

File name of the photo.

Type: str

post¶

The Post Object the photo belongs to.

Type: Post

Video¶

class Weverse.models.Video(**kwargs)¶

A Video object that represents a Weverse Video that belongs to media or a post.

It is not suggested to create a Video manually, but rather through the following method: Weverse.objects.create_video_objects

The information retrieved on a Video is directly from the Weverse API and altered to fit this class.

Videos do not have unique IDs.

x == y: Check if the Video URL and Post are the same.

x != y: Check if the Video objects are not equal.

str(x): Returns the Video URL.

len(x): Returns the length of the video in seconds.

Parameters

video_url (int) – Direct URL to the video.
thumbnail_url (str) – URL of the thumbnail.
thumbnail_width (int) – Width of the thumbnail
thumbnail_height (int) – Height of the thumbnail.
length (int) – Duration of the video in seconds.

video_url¶

Direct URL to the video.

Type: int

thumbnail_url¶

URL of the thumbnail.

Type: str

thumbnail_width¶

Width of the thumbnail

Type: int

thumbnail_height¶

Height of the thumbnail.

Type: int

length¶

Duration of the video in seconds.

Type: int

post¶

The Post Object the video belongs to.

Type: Optional[Post]

Artist¶

class Weverse.models.Artist(**kwargs)¶

An Artist object that represents a Weverse Artist that belongs in a community.

It is not suggested to create an Artist manually, but rather through the following method: Weverse.objects.create_artist_objects

The information retrieved on an Artist is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Artists have the same ID.

x != y: Checks if two Artists do not have the same ID.

str(x): Returns the Artist’s primary name.

Parameters

id (int) – The Artist ID.
community_user_id (int) – Artist’s ID in the community.
name (str) – The Primary Artist Name.
list_name (list) – A list of names for the Artist.
is_online (bool) – Whether the Artist is currently online
profile_nick_name (str) – Artist nickname.
profile_img_path (str) – Image URL for the Artist’s profile.
is_birthday (bool) – Whether it is the Artist’s birthday.
group_name (str) – The group name the Artist is associated with.
max_comment_count (int) – The maximum amount of comments this Artist can post.
community_id (int) – The ID of the community this Artist object was selected from.
is_enabled (bool) – If the Artist account is enabled.
has_new_to_fans (bool) – If the Artist has a new post for fans.
has_new_private_to_fans (bool) – If the Artist has a new private post for fans.
to_fan_last_id (int) – The latest tofan post ID.
to_fan_last_created_at – When the artist’s last tofan post was created.
to_fan_last_expire_in – When the artist’s last tofan post expires.
birthday_img_url (str) – A direct image url to the artist’s birthday image.
community (Community) – The community the Artist is in.
posts (list) – A list of posts the Artist has.

id¶

The Artist ID.

Type: int

community_user_id¶

Artist’s ID in the community.

Type: int

name¶

The Primary Artist Name.

Type: str

list_name¶

A list of names for the Artist.

Type: list

is_online¶

Whether the Artist is currently online

Type: bool

profile_nick_name¶

Artist nickname.

Type: str

profile_img_path¶

Image URL for the Artist’s profile.

Type: str

is_birthday¶

Whether it is the Artist’s birthday.

Type: bool

group_name¶

The group name the Artist is associated with.

Type: str

max_comment_count¶

The maximum amount of comments this Artist can post.

Type: int

community_id¶

The ID of the community this Artist object was selected from.

Type: int

is_enabled¶

If the Artist account is enabled.

Type: bool

has_new_to_fans¶

If the Artist has a new post for fans.

Type: bool

has_new_private_to_fans¶

If the Artist has a new private post for fans.

Type: bool

to_fan_last_id¶

The latest tofan post ID.

Type: int

to_fan_last_created_at¶: When the artist’s last tofan post was created.

to_fan_last_expire_in¶: When the artist’s last tofan post expires.

birthday_img_url¶

A direct image url to the artist’s birthday image.

Type: str

community¶

The community the Artist is in.

Type: Community

posts¶

A list of posts the Artist has.

Type: list

Comment¶

class Weverse.models.Comment(**kwargs)¶

A Comment object that represents a Weverse Comment that belongs to an Artist.

It is not suggested to create a Comment manually, but rather through the following method: Weverse.objects.create_comment_objects

The information retrieved on a Comment is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Comments have the same ID.

x != y: Checks if two Comments do not have the same ID.

str(x): Returns the comment’s body.

Parameters

id (int) – The ID of the comment.
body (str) – The comment content AKA the body of the message.
comment_count (int) – Amount of comments inside of this comment (replies).
like_count (int) – Amount of likes on the comment.
has_my_like (bool) – Whether the client has liked the comment.
is_blind (bool) – NOT SURE WHAT THIS IS
post_id (int) – The Post ID that the comment was created under.
created_at – The time the comment was created.
updated_at – The time the comment was updated.

id¶

The ID of the comment.

Type: int

body¶

The comment content AKA the body of the message.

Type: str

comment_count¶

Amount of comments inside of this comment (replies).

Type: int

like_count¶

Amount of likes on the comment.

Type: int

has_my_like¶

Whether the client has liked the comment.

Type: bool

is_blind¶

NOT SURE WHAT THIS IS

Type: bool

post_id¶

The Post ID that the comment was created under.

Type: int

created_at¶: The time the comment was created.

updated_at¶: The time the comment was updated.

post¶

The Post Object the comment belongs to.

Type: Post

Post¶

class Weverse.models.Post(**kwargs)¶

A Post object that represents a Weverse Post.

It is not suggested to create a Post manually, but rather through the following method: Weverse.objects.create_post_objects

The information retrieved on a Post is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Post objects have the same ID.

x != y: Checks if two Post objects do not have the same ID.

str(x): Returns the Post body message.

len(x): Returns the amount of images (not videos) available.

Parameters

id (int) – The ID of the post.
community_tab_id (int) – The tab the post is under.
type (str) – The type of Post.
body (str) – Body Message on the Post.
comment_count (int) – Current amount of comments on the Post
like_count (int) – Current amount of likes on the Post
max_comment_count (int) – Maximum amount of comments that can be on the Post
has_my_like (bool) – If the client user has the post liked.
has_my_bookmark (bool) – If the client user has the post bookmarked.
created_at – When the post was created
updated_at – When the post was last modified.
is_locked (bool) – Whether the post is locked.
is_blind (bool) – Whether the post is visible?? Unknown
is_active (bool) – Whether the post is active.
is_private (bool) – Whether the post is private.
photos (List[Photo]) – A list of photos under the post.
videos (List[Video]) – A list of videos under the post.
is_hot_trending_post (bool) – If the post is trending.
is_limit_comment (bool) – If the comments are limited.
artist_comments (List[Comment]) – The Artist comments under the post.
community_artist_id (int) – The Community Artist ID that made the post.
artist_id (int) – The ID of the Artist that made the post.

id¶

The ID of the post.

Type: int

community_tab_id¶

The tab the post is under.

Type: int

type¶

The type of Post.

Type: str

body¶

Body Message on the Post.

Type: str

comment_count¶

Current amount of comments on the Post

Type: int

like_count¶

Current amount of likes on the Post

Type: int

max_comment_count¶

Maximum amount of comments that can be on the Post

Type: int

has_my_like¶

If the client user has the post liked.

Type: bool

has_my_bookmark¶

If the client user has the post bookmarked.

Type: bool

created_at¶: When the post was created

updated_at¶: When the post was last modified.

is_locked¶

Whether the post is locked.

Type: bool

is_blind¶

Whether the post is visible?? Unknown

Type: bool

is_active¶

Whether the post is active.

Type: bool

is_private¶

Whether the post is private.

Type: bool

photos¶

A list of photos under the post.

Type: List[Photo]

videos¶

A list of videos under the post.

Type: List[Video]

is_hot_trending_post¶

If the post is trending.

Type: bool

is_limit_comment¶

If the comments are limited.

Type: bool

artist_comments¶

The Artist comments under the post.

Type: List[Comment]

community_artist_id¶

The Community Artist ID that made the post.

Type: int

artist_id¶

The ID of the Artist that made the post.

Type: int

artist¶

The Artist Object the post belongs to.

Type: Artist

Tab¶

class Weverse.models.Tab(tab_id=None, name=None)¶

A Post object that represents a Weverse Post.

It is not suggested to create a Post manually, but rather through the following method: Weverse.objects.create_post_objects

The information retrieved on a Post is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Tab objects have the same ID.

x != y: Check if the IDs of the Tab objects are not equal.

str(x): Returns the Tab name.

Parameters

tab_id ([Optional] int) – The ID of the Tab.
name ([Optional] str) – The Tab name.

id¶

The ID of the Tab.

Type: int

name¶

The Tab name.

Type: str

Media¶

class Weverse.models.Media(**kwargs)¶

A Media object that represents a Weverse Media Post.

It is not suggested to create a Media object manually, but rather through the following method: Weverse.objects.create_media_object

The information retrieved on Media is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Media objects have the same ID.

x != y: Checks if two Media objects do not have the same ID.

str(x): Returns the Media body message.

len(x): Returns the amount of images (not videos) in the Media object.

Parameters

id (int) – ID of the Media post.
community_id (int) – ID of the Community the media post was made in.
body (str) – The media content AKA the body of the message.
type (str) – The type of media post it is.
thumbnail_path (str) – The (url??) of the thumbnail.
title (str) – The title of the media post.
level – The level of access the media post is categorized under.
video_link (str) – The video link supplied under the media post.
youtube_id (str) – The youtube video ID.

id¶

ID of the Media post.

Type: int

community_id¶

ID of the Community the media post was made in.

Type: int

body¶

The media content AKA the body of the message.

Type: str

type¶

The type of media post it is.

Type: str

thumbnail_path¶

The (url??) of the thumbnail.

Type: str

title¶

The title of the media post.

Type: str

level¶: The level of access the media post is categorized under.

video_link¶

The video link supplied under the media post.

Type: str

youtube_id¶

The youtube video ID.

Type: str

photos¶

A list of photos under the media post.

Type: List[Photo]

Announcement¶

class Weverse.models.Announcement(**kwargs)¶

An Announcement object that represents a Weverse Notice for a Community.

It is not suggested to create an Announcement manually, but rather through the following method: Weverse.objects.create_announcement_objects

The information retrieved on a Post is directly from the Weverse API and altered to fit this class.

x == y: Checks if two Announcement objects have the same ID.

x != y: Checks if two Announcement objects do not have the same ID.

str(x): Returns the Announcement content.

Parameters

id (int) – The ID of the post.
communityId (int) – The Community ID.
title (str) – The title of the announcement notice.
content (str) – The HTML body of the page notice.
createdAt (str) – Timestamp with the date of when the announcement was created.
exposedAt (str) – Timestamp with the date of when the announcement was released.
categoryId (int) – Category that the announcement belongs to (used for paginating or quick endpoint access)
fcOnly (bool) – If only premium members have access to the announcement.

id¶

The ID of the post.

Type: int

community_id¶

The Community ID.

Type: int

title¶

The title of the announcement notice.

Type: str

html_content¶

The HTML body of the page notice.

Type: str

created_at¶

Timestamp with the date of when the announcement was created.

Type: str

exposed_at¶

Timestamp with the date of when the announcement was released.

Type: str

category_id¶

Category that the announcement belongs to (used for paginating or quick endpoint access)

Type: int

fc_only¶

If only premium members have access to the announcement.

Type: bool

image_url¶

An image url if one is present.

Type: Optional[str]

content¶

Body Content without the HTML tags.

Type: str

Model Creation¶

Weverse.objects.create_announcement_object(announcement_info: dict) → Weverse.models.announcement.Announcement¶

Creates and returns an announcement object

Parameters: announcement_info – Announcement information from endpoint.
Returns: Announcement

Weverse.objects.create_artist_objects(current_artists: list) → list¶

Creates artist objects based on a list of information sent in and returns the objects.

Parameters: current_artists – Artist information received from endpoint.
Returns: List[Artist]

Weverse.objects.create_comment_objects(current_comments: list) → list¶

Creates & Returns comment objects based on a list of comments

Parameters: current_comments – comment information from endpoint.
Returns: List[Comment]

Weverse.objects.create_community_objects(current_communities: list) → dict¶

Creates community objects based on a list of information sent in and returns the objects.

Parameters: current_communities – Community information received from endpoint.
Returns: dict{community id: Community}

Weverse.objects.create_media_object(media_info: dict, ignore_photos=False) → Weverse.models.media.Media¶

Creates and returns a media object

Parameters

media_info – media information from endpoint.
ignore_photos – Whether to ignore the photos that belong in the media object. (Other methods can create it themselves.)

Returns

Media

Weverse.objects.create_notification_objects(current_notifications: list) → list¶

Creates notification objects based on a list of information sent in and returns the objects.

Parameters: current_notifications – Notification information received from endpoint.
Returns: List[Notification]

Weverse.objects.create_photo_objects(current_photos: list) → list¶

Creates & Returns photo objects based on a list of photos

Parameters: current_photos – photo information from endpoint.
Returns: List[Photo]

Weverse.objects.create_post_objects(current_posts: list, community: Weverse.models.community.Community, new=False) → list¶

Creates post objects based on a list of posts sent in and the community and returns the objects.

Parameters

current_posts – Post information received from endpoint.
community – Community that the post belongs in.
new – bool Whether or not the post is new.

Returns

List[Post]

Weverse.objects.create_tab_objects(current_tabs: list) → list¶

Creates tab objects based on a list of information sent in and returns the objects.

Parameters: current_tabs – Tab information received from endpoint.
Returns: List[Tab]

Weverse.objects.create_video_objects(current_videos: list) → list¶

Creates & Returns video objects based on a list of videos.

Parameters: current_videos – Video information from api endpoint.
Returns: List[Video]

Weverse.objects.iterate_community_media_categories()¶

Iterates through community media categories, creates Media posts and returns a list of them.

Parameters: all_media_categories – A dict containing media posts that are filtered by category.
Returns: [List[Media], List[dict]] A list of Video Media objects and a list of dicts containing photo media objects to later make own calls on to retrieve photos.

Exceptions¶

Invalid Token¶

Page Not Found¶

Being Rate Limited¶

Get Account Token¶

Your account token is needed (Will need to be updated about every 6 months iirc).

Note that it is now possible to log-in with a username and password to prevent manual updates.

In order to get your account token, go to https://www.weverse.io/ and Inspect Element (F12).

Then go to the Network tab and filter by XHR.

Then refresh your page (F5) and look for info or me under XHR.

Under Headers, scroll to the bottom and view the request headers.

You want to copy everything past authorization: Bearer.

For example, you may see (This is just an example):

authorization: Bearer ABCDEFGHIJKLMNOPQRSTUVWXYZ

Then ABCDEFGHIJKLMNOPQRSTUVWXYZ would be your auth token for Weverse.

It is suggested to have the auth token as an environment variable.

IMPORTANT NOTE: Not all korean key-phrases may be logged. Scroll to the bottom of the Weverse page when you are logged in and click “English” to set the account language to English.

Asynchronous Usage¶

# Asynchronous
import asyncio
import aiohttp
from Weverse.error import InvalidToken
from Weverse.weverseasync import WeverseClientAsync

# THERE IS A MORE DETAILED EXAMPLE IN THE EXAMPLES FOLDER
# https://github.com/MujyKun/Weverse/blob/main/examples/asynchronous.py

token = "fake_token"  # REQUIRED
# THE EXAMPLE IN THE EXAMPLES FOLDER WILL SHOW YOU HOW TO LOGIN WITH A USERNAME AND PASSWORD AND SET UP HOOKS.

# It is advised to pass in your own web session as it is not closed in Weverse
web_session = aiohttp.ClientSession()  # A session is created by default
weverse_client = WeverseClientAsync(authorization=token, verbose=True, loop=asyncio.get_event_loop(),
                                    web_session=web_session)
try:
    # creates all the cache that is specified. If the create parameters are set to True, they will take a very long time.
    await weverse_client.start(create_old_posts=True, create_media=True)
except InvalidToken:
    print("Invalid Token")

Synchronous Usage¶

# Synchronous
import requests
from Weverse.weversesync import WeverseClientSync
from Weverse.error import InvalidToken

# THERE IS A MORE DETAILED EXAMPLE IN THE EXAMPLES FOLDER
# https://github.com/MujyKun/Weverse/blob/main/examples/synchronous.py

token = "fake_token"  # REQUIRED
# THE EXAMPLE IN THE EXAMPLES FOLDER WILL SHOW YOU HOW TO LOGIN WITH A USERNAME AND PASSWORD AND SET UP HOOKS.

# It is advised to pass in your own web session as it is not closed in Weverse
web_session = requests.Session()  # A session is created by default
weverse_client = WeverseClientSync(authorization=token, verbose=True)
try:
    # creates all the cache that is specified. If the create parameters are set to True, they will take a very long time.
    weverse_client.start(create_old_posts=True, create_media=True)
except InvalidToken:
    print("Invalid Token")