From baa8fa2cc8d1bcc7aabc7fdef5a93677fed10be5 Mon Sep 17 00:00:00 2001
From: Tino Laomahei <tinolaomahei@gmail.com>
Date: Sat, 24 May 2025 22:08:44 +1200
Subject: [PATCH] add api response type

---
 README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)

diff --git a/README.md b/README.md
index 5fe7e4f..87af2f3 100644
--- a/README.md
+++ b/README.md
@@ -56,6 +56,7 @@
   - [Tiktok Video Comments](#tiktok-video-comments-1)
   - [Tiktok User Posts](#tiktok-user-posts)
   - [Tiktok User Liked Videos](#tiktok-user-liked-videos)
+  - [Tiktok Collection](#tiktok-collection)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -806,6 +807,62 @@ interface TiktokUserFavoriteVideosResponse {
 }
 ```
 
+## Tiktok Collection
+
+### Collection Response
+
+```typescript
+interface TiktokCollectionResponse {
+  status: "success" | "error"
+  message?: string
+  result?: {
+    itemList: Array<{
+      id: string
+      desc: string
+      createTime: number
+      author?: {
+        id: string
+        uniqueId: string
+        nickname: string
+        avatarThumb: string
+        avatarMedium: string
+        avatarLarger: string
+        signature: string
+        verified: boolean
+      }
+      statistics?: {
+        playCount: number
+        diggCount: number
+        shareCount: number
+        commentCount: number
+        collectCount: number
+      }
+      video?: {
+        id: string
+        height: number
+        width: number
+        duration: number
+        ratio: string
+        cover: string
+        originCover: string
+        dynamicCover: string
+        playAddr: string
+        downloadAddr: string
+        format: string
+        bitrate: number
+      }
+      textExtra?: Array<{
+        hashtagName: string
+        hashtagId: string
+        type: number
+      }>
+    }>
+    hasMore: boolean
+    cursor: string
+  }
+}
+```
+
 # Changelog
 
 - All changes will be documented in the [CHANGELOG.md](https://github.com/TobyG74/tiktok-api-dl/blob/master/CHANGELOG.md) file.