Channels and Boards

Details about channels and boards

If you know the channel ID (referred to as channelCode in the API), you can retrieve information about the channel such as

• Channel Name

• Channel Profile Image

  • This is the original link to the channel profile image as used by the original site. It is not guaranteed that the content will be up forever.

  • You may prefer to use the VLIVE Archive API to more easily access the channel profile images.

• The number of members/subscribers of the channel (memberCount)

• The number of videos on the channel (videoCountOfStar)

• The number of likes across all videos on the channel (videoLikeCountOfStar)

• The number of views/plays across all videos on the channel (videoPlayCountOfStar)

• The number of comments across all videos on the channel (fVideoCommentCountOfStar)

For each of the fields memberCount, videoCountOfStar, videoLikeCountOfStar, videoPlayCountOfStar and fVideoCommentCountOfStar there are also pre-formatted fields available. These are

• fmemberCount

• fVideoCountOfStar

• fVideoLikeCountOfStar

• fVideoPlayCountOfStar

• fVideoCommentCountOfStar

These fields are formatted in a way that is consistent with how the values are presented via the original site. Note that the formatting is lossless: it does not encode the precise number of members, likes, views, comments etc but rather provides an estimation to the nearest million/thousand/hundred etc.

All the fields (with the exception of the pre-formatted fields explained above) use the original field names from the original VLIVE site's API.

Get information about a VLIVE channel

get

Path parameters

channelCodestringRequired

The code of the channel

Responses

200

Successful response

application/json

404

Channel not found

500

Internal server error

get

HTTPcURLJavaScriptPython

GET /channel/{channelCode} HTTP/1.1
Host: api.vlivearchive.com
Accept: */*

{
  "boards": [
    {
      "boardId": 1,
      "boardType": "text",
      "channelCode": "text",
      "payRequired": true,
      "readAllowedLabel": "text",
      "title": "text"
    }
  ],
  "channel": {
    "backgroundColor": "text",
    "channelCode": "text",
    "channelCoverImage": "https://example.com",
    "channelName": "text",
    "channelProfileImage": "https://example.com",
    "fVideoCommentCountOfStar": "text",
    "fVideoCountOfStar": "text",
    "fVideoLikeCountOfStar": "text",
    "fVideoPlayCountOfStar": "text",
    "fmemberCount": "text",
    "memberCount": 1,
    "openAt": 1,
    "postCountOfStar": 1,
    "qrCode": "https://example.com",
    "representativeColor": "text",
    "showUpcoming": true,
    "snsShareImg": "https://example.com",
    "useMemberLevel": true,
    "videoCommentCountOfStar": 1,
    "videoCountOfStar": 1,
    "videoLikeCountOfStar": 1,
    "videoPlayCountOfStar": 1
  }
}

Boards

Each channel can have a list of boards. Typically for the content that we are interested in (videos and in particular, live stream videos), these are all on the one board. The default name for this board is Star Board with the boardType of STAR.

There may be other boards but these were not archived by this project. If you have information on these boards, feel free to reach out to me.

Other boards may include

• Member only boards

• Paid subscription boards (VLIVE+)

• Text boards for fans to post their own messages/interact with other fans

The list of boards for a channel is provided in the /channel/{channelCode} api.