Service
Connects a Weverse account through credential login with email OTP verification, then provides read access to communities, posts, comments, media, member and membership profiles, notifications, Jelly balance, DM state, and Weverse Shop banners, sales, and pickup information. Public community and Shop data can also be read without a connected account.
98.41%30-day uptimeAvg response51ms
Selecting a row opens the reference for that API.
| Method | API | Path | Summary |
|---|---|---|---|
| POST | /v1/weverse/account-info | Gets the connected Weverse account information, including the account email. Requires a connected account. Do NOT use for the user's profile fields such as name and status — use weverse:current-user instead. Returns wid, email, nickname, userKey, country, and smsVerified. | |
| POST | /v1/weverse/app-state | Gets Weverse web app state such as the country code, video quality list, locale labels, and ads configuration. Use when you need client configuration values. Returns country_code, qualityList, localeLabelList, ads, aisearchEnabled, and calendar. | |
| POST | /v1/weverse/artist-highlight | Gets artist highlight data for a Weverse community: artist profiles, introduction, and official site links. Use when you need an overview of the community's artists. Do NOT use for the community's HIGHLIGHT tab layout — use weverse:community-tab with tab HIGHLIGHT instead. Returns artistProfiles, community, introduceInfo, and siteInfos. | |
| POST | /v1/weverse/category-media | Lists media posts in one Weverse media category, identified by categoryId. Use when you have a category from weverse:community-media-categories. Do NOT use for all media of a community — use weverse:community-all-media instead. Returns paging and data (post summaries). | |
| POST | /v1/weverse/comment | Gets one Weverse comment by comment ID. Use when you have a commentId and need its body or counts. Do NOT use for the replies under it — use weverse:comment-replies instead. Returns commentId, body, createdAt, emotionCount, commentCount, writtenIn, and parent. | |
| POST | /v1/weverse/comment-artist-replies |
Scopes define which services and APIs a key may call.
Retry rules and backoff behaviour for idempotent calls.
Receive events such as reservation confirmations and delivery updates.
| Lists only the artist replies under a Weverse comment. Use when you want artist replies specifically. Do NOT use for all replies — use weverse:comment-replies instead. Returns data (artist replies). |
| POST | /v1/weverse/comment-replies | Lists all replies under a Weverse comment. Use when you want every reply regardless of author. Do NOT use when you only want artist replies — use weverse:comment-artist-replies instead. Returns paging and data (comments). |
| POST | /v1/weverse/community | Gets a Weverse community profile by community ID. Use when you already have a communityId and need its name, URL path, open date, or images. Do NOT use to find a community by name — use weverse:search-communities instead. Returns communityId, communityName, urlPath, openDate, logoImage, homeHeaderImage, and availableActions. |
| POST | /v1/weverse/community-all-media | Lists all media posts for a Weverse community. Use when you want the community's full media home. Do NOT use for one category only — use weverse:category-media instead. Returns paging and data (post summaries). |
| POST | /v1/weverse/community-media-categories | Lists the media categories of a Weverse community, optionally with the posts in each category. Use when you need categoryId values before calling weverse:category-media. Do NOT use to list the media posts themselves — use weverse:community-all-media instead. Returns paging and data (category and posts). |
| POST | /v1/weverse/community-tab | Gets the content of one Weverse community tab (ARTIST, FAN, HIGHLIGHT, MEDIA_HOME, or NOTICE). Use when you need a tab as it is laid out in the Weverse app. Do NOT use for the LIVE tab — use weverse:live-tab instead. Returns tabKey and content. |
| POST | /v1/weverse/connection-health | Validate Weverse token health. |
| POST | /v1/weverse/current-user | Gets the connected Weverse user profile. Requires a connected account. Use when you need the user's wid, nickname, country, or status. Do NOT use for the account email and account-level details — use weverse:account-info instead. Returns wid, userKey, country, firstName, lastName, nickname, smsVerified, and status. |
| POST | /v1/weverse/dm-subscriptions | Lists the connected user's Weverse DM subscription state. Requires a connected account. Do NOT use for the DM user profile — use weverse:dm-user instead. Returns isSubscribed. |
| POST | /v1/weverse/dm-user | Gets the connected user's Weverse DM profile. Requires a connected account. Use when you need the DM user type and status. Do NOT use for DM subscription state — use weverse:dm-subscriptions instead. Returns wid, type, status, and isCommunityArtist. |
| POST | /v1/weverse/fan-letter-posts | Lists fan letter posts for a Weverse community. Use when you want fan letters specifically. Do NOT use for the general feed — use weverse:feed-posts instead. Returns paging and data (post summaries). |
| POST | /v1/weverse/feed-posts | Lists posts from a Weverse community's feed tab. Use when you want the general fan feed of a community. Do NOT use for fan letters, LIVE posts, or media — use weverse:fan-letter-posts, weverse:live-posts, or weverse:community-all-media instead. Returns paging and data (post summaries). |
| POST | /v1/weverse/group-communities | Lists the Weverse communities that belong to one discovery group, identified by groupKey. Use when you have a group key from weverse:groups and want its communities. Do NOT use to list the groups themselves — use weverse:groups instead. Returns paging and data (community summaries). |
| POST | /v1/weverse/groups | Lists Weverse community discovery groups. Use when you need groupKey values before calling weverse:group-communities. Do NOT use to list communities — use weverse:group-communities or weverse:search-communities instead. Returns paging and data (type, key, name). |
| POST | /v1/weverse/jelly-balance | Gets the connected user's Jelly balance (Weverse in-app currency). Requires a connected account. Returns balance, maxChargeableAmount, and chargeableAmount. |
| POST | /v1/weverse/live-posts | Lists LIVE posts for a Weverse community. Use when you want a paginated list of LIVE posts. Do NOT use for the whole LIVE tab — use weverse:live-tab instead. Returns paging and data (post summaries). |
| POST | /v1/weverse/live-tab | Gets the LIVE tab of a Weverse community, including its post list. Use when you need the LIVE tab as a whole. Do NOT use when you only need the paginated list of LIVE posts — use weverse:live-posts instead. Returns liveTabPosts (paging and data). |
| POST | /v1/weverse/media-group-posts | Lists the Weverse media posts related to one media post (the same media group). Use when you have a media postId and want its related items. Do NOT use to browse a category — use weverse:category-media instead. Returns relatedMedia (post summaries). |
| POST | /v1/weverse/member | Gets a Weverse member profile by memberId. Use when you have a memberId and need the profile name, image, join status, or membership flags. Do NOT use for the connected user's own membership — use weverse:my-membership instead. Returns a member profile (memberId, communityId, joined, profileName, profileImageUrl, hasMembership, and more). |
| POST | /v1/weverse/member-comments | Lists comments written by one Weverse member, identified by memberId. Use when you want a specific member's comments. Do NOT use for a member's posts — use weverse:member-posts instead. Returns paging and data (comments). |
| POST | /v1/weverse/member-posts | Lists posts written by one Weverse member, identified by memberId. Use when you want a specific member's posts, for example an artist's. Do NOT use for a member's comments — use weverse:member-comments instead. Returns paging and data (post summaries). |
| POST | /v1/weverse/membership-benefits | Gets the connected account's membership benefits for one Weverse community. Requires a connected account. Use when you need the benefit list of the user's membership. Do NOT use for the membership profile itself — use weverse:my-membership instead. Returns community and extension (benefits). |
| POST | /v1/weverse/my-membership | Gets the connected account's own membership profile for one Weverse community. Requires a connected account. Use when you need the user's member record for that community (memberId, joined, hasMembership). Do NOT use for another member's profile — use weverse:member instead. For the benefit list, use weverse:membership-benefits. Returns a member profile. |
| POST | /v1/weverse/post | Gets one Weverse post by post ID. Use when you have a single postId and need its body, type, counts, or extension data. Do NOT use for several posts at once — use weverse:posts instead. Returns a post summary (postId, body, plainBody, postType, emotionCount, commentCount, published_at, and more). |
| POST | /v1/weverse/post-artist-comments | Lists only the artist comments on a Weverse post. Use when you want artist comments specifically. Do NOT use for all comments — use weverse:post-comments instead. Returns data (artist comments). |
| POST | /v1/weverse/post-comments | Lists all comments on a Weverse post. Use when you want every comment regardless of author. Do NOT use when you only want artist comments — use weverse:post-artist-comments instead. Returns paging and data (comments). |
| POST | /v1/weverse/posts | Gets up to 50 Weverse posts in one call by their IDs. Use when you have multiple postId values. Do NOT use for a single post — use weverse:post instead. Returns an array of post summaries. |
| POST | /v1/weverse/resolve-community | Resolves a Weverse community ID and URL path from an artist code such as `exo`. Use when you know the artist's URL code but not its communityId. Do NOT use for free-text search — use weverse:search-communities instead. Returns communityId and urlPath. |
| POST | /v1/weverse/search-communities | Searches Weverse communities by query. Use when you need to find a community by artist or community name. Do NOT use when you already know the artist URL code — use weverse:resolve-community instead. Returns paging and data (community summaries). |
| POST | /v1/weverse/shop-artist-banners | Lists the banners on one artist's Weverse Shop home, identified by artistId. Use when you need a specific artist's shop banners. Do NOT use for the global Shop home — use weverse:shop-home-banners instead. Returns mainBanners and lineBanners. |
| POST | /v1/weverse/shop-artist-new-arrivals | Lists recent Weverse Shop sales for one artist, identified by id (the artist ID). Use when you have a single artist ID. Do NOT use for several artists at once — use weverse:shop-home-new-arrivals instead. Returns artistInfo and sales. |
| POST | /v1/weverse/shop-cart-count | Gets the connected user's Weverse Shop cart item counts. Requires a connected account. Returns totalItemCount, deliveryItemCount, and pickupItemCount. |
| POST | /v1/weverse/shop-home-banners | Lists Weverse Shop home banners. Use when you need the banners on the Shop home page. Do NOT use for one artist's shop home — use weverse:shop-artist-banners instead. Returns banners. |
| POST | /v1/weverse/shop-home-curated-collections | Lists the sale curation blocks shown on the Weverse Shop home page. Use when you need curated sale collections. Do NOT use for recommendations by artist — use weverse:shop-home-recommendations instead. Returns curations. |
| POST | /v1/weverse/shop-home-new-arrivals | Lists recent Weverse Shop sales for several artists at once, grouped by artist. Use when you have a comma-separated list of artist IDs (artistIds). Do NOT use for a single artist — use weverse:shop-artist-new-arrivals instead. Returns data (artist and sales). |
| POST | /v1/weverse/shop-home-notices | Lists Weverse Shop home notices. Use when you need shop-wide announcements such as shipping or customs notices. Returns an array of notices (id, title, isNewIcon, artistId, displayStartAt). |
| POST | /v1/weverse/shop-home-print-on-demand | Lists the POD sales blocks shown on the Weverse Shop home page, limited by artistSize and itemSize. Use when you need the POD merchandise section. Do NOT use for curated sale collections — use weverse:shop-home-curated-collections instead. Returns podSales. |
| POST | /v1/weverse/shop-home-recommendations | Lists recommended Weverse Shop sales for several artists, as shown on the Shop home page, grouped by artist. Use when you have a comma-separated list of artist IDs (artistIds). Do NOT use for recommendations related to one sale — use weverse:shop-related-items instead. Returns data (artist and sales). |
| POST | /v1/weverse/shop-marketing-banners | Lists Weverse Shop marketing banners for the given sales (saleIds) in a display area such as SALE_DETAIL. Use when you need the promotional banners shown on a sale detail page. Do NOT use for home or artist-home banners — use weverse:shop-home-banners or weverse:shop-artist-banners instead. Returns banners. |
| POST | /v1/weverse/shop-pickup-banner | Gets Weverse Shop pickup banner data (merchandise pickup guides). Use when you need the pickup guide banners. Do NOT use for one pickup event — use weverse:shop-pickup-detail instead. Returns pickupGuideResponses. |
| POST | /v1/weverse/shop-pickup-detail | Gets the detail of one Weverse Shop merchandise pickup event, identified by pickupId. Use when you need the pickup name, status, time zone, and location. Do NOT use for the pickup guide banners — use weverse:shop-pickup-banner instead. Returns pickupId, name, pickupStatus, timeZone, and location. |
| POST | /v1/weverse/shop-related-items | Lists Weverse Shop items recommended alongside one sale, identified by saleId. Use when you need related products for a sale detail page. Do NOT use for home-page recommendations by artist — use weverse:shop-home-recommendations instead. Returns recommendationsTitle and recommendationsSales. |
| POST | /v1/weverse/shop-return-exchange-info | Gets Weverse Shop return and exchange policy text for one sale type, identified by typeId. Use when you need the return and exchange guidance shown on a sale page. Returns an array of sections (title and descriptions). |
| POST | /v1/weverse/showcased-rooms | Lists showcased Weverse DM rooms for the connected user. Requires a connected account. Returns data (rooms) and totalCount. |
| POST | /v1/weverse/unseen-notification-count | Gets the number of unseen notifications for the connected user. Requires a connected account. Returns count. |
| POST | /v1/weverse/user-settings | Gets the connected user's Weverse settings. Requires a connected account. Use when you need restricted mode, media rating, or translation preferences. Returns restrictedMode, mediaRating, autoTranslate, and langTranslate. |
