TikTok Profile Scraper

1{
2  "openapi": "3.0.1",
3  "info": {
4    "version": "0.0",
5    "x-build-id": "7618RVWrgQnk5u1qp"
6  },
7  "servers": [
8    {
9      "url": "https://api.apify.com/v2"
10    }
11  ],
12  "paths": {
13    "/acts/clockworks~tiktok-profile-scraper/run-sync-get-dataset-items": {
14      "post": {
15        "operationId": "run-sync-get-dataset-items-clockworks-tiktok-profile-scraper",
16        "x-openai-isConsequential": false,
17        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18        "tags": [
19          "Run Actor"
20        ],
21        "requestBody": {
22          "required": true,
23          "content": {
24            "application/json": {
25              "schema": {
26                "$ref": "#/components/schemas/inputSchema"
27              }
28            }
29          }
30        },
31        "parameters": [
32          {
33            "name": "token",
34            "in": "query",
35            "required": true,
36            "schema": {
37              "type": "string"
38            },
39            "description": "Enter your Apify token here"
40          }
41        ],
42        "responses": {
43          "200": {
44            "description": "OK"
45          }
46        }
47      }
48    },
49    "/acts/clockworks~tiktok-profile-scraper/runs": {
50      "post": {
51        "operationId": "runs-sync-clockworks-tiktok-profile-scraper",
52        "x-openai-isConsequential": false,
53        "summary": "Executes an Actor and returns information about the initiated run in response.",
54        "tags": [
55          "Run Actor"
56        ],
57        "requestBody": {
58          "required": true,
59          "content": {
60            "application/json": {
61              "schema": {
62                "$ref": "#/components/schemas/inputSchema"
63              }
64            }
65          }
66        },
67        "parameters": [
68          {
69            "name": "token",
70            "in": "query",
71            "required": true,
72            "schema": {
73              "type": "string"
74            },
75            "description": "Enter your Apify token here"
76          }
77        ],
78        "responses": {
79          "200": {
80            "description": "OK",
81            "content": {
82              "application/json": {
83                "schema": {
84                  "$ref": "#/components/schemas/runsResponseSchema"
85                }
86              }
87            }
88          }
89        }
90      }
91    },
92    "/acts/clockworks~tiktok-profile-scraper/run-sync": {
93      "post": {
94        "operationId": "run-sync-clockworks-tiktok-profile-scraper",
95        "x-openai-isConsequential": false,
96        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97        "tags": [
98          "Run Actor"
99        ],
100        "requestBody": {
101          "required": true,
102          "content": {
103            "application/json": {
104              "schema": {
105                "$ref": "#/components/schemas/inputSchema"
106              }
107            }
108          }
109        },
110        "parameters": [
111          {
112            "name": "token",
113            "in": "query",
114            "required": true,
115            "schema": {
116              "type": "string"
117            },
118            "description": "Enter your Apify token here"
119          }
120        ],
121        "responses": {
122          "200": {
123            "description": "OK"
124          }
125        }
126      }
127    }
128  },
129  "components": {
130    "schemas": {
131      "inputSchema": {
132        "type": "object",
133        "required": [
134          "profiles"
135        ],
136        "properties": {
137          "profiles": {
138            "title": "Profile(s)",
139            "type": "array",
140            "description": "Add the name of user you want to scrape.",
141            "items": {
142              "type": "string"
143            }
144          },
145          "profileScrapeSections": {
146            "title": "Profile sections to scrape",
147            "minItems": 1,
148            "uniqueItems": true,
149            "type": "array",
150            "description": "If a profile has reposted videos, you can scrape them by selecting 'Reposts'",
151            "items": {
152              "type": "string",
153              "enum": [
154                "videos",
155                "reposts"
156              ],
157              "enumTitles": [
158                "Videos",
159                "Reposts"
160              ]
161            },
162            "default": [
163              "videos"
164            ]
165          },
166          "profileSorting": {
167            "title": "Profile video sorting",
168            "enum": [
169              "latest",
170              "popular",
171              "oldest"
172            ],
173            "type": "string",
174            "description": "Select Latest to scrape the most recent videos first, Oldest - the oldest videos first, Popular - the most popular videos first. Date filters only work with Latest and Oldest. Only supported for Videos section",
175            "default": "latest"
176          },
177          "resultsPerPage": {
178            "title": "Max posts per profile",
179            "minimum": 1,
180            "type": "integer",
181            "description": "The number of posts that will be scraped from every profile.",
182            "default": 100
183          },
184          "oldestPostDate": {
185            "title": "Posts newer than...",
186            "type": "string",
187            "description": "Works only from profiles, not hashtags. Only posts uploaded after or on this date will be scraped."
188          },
189          "scrapeLastNDays": {
190            "title": "Posts from last X days ",
191            "minimum": 0,
192            "type": "integer",
193            "description": "Specify how old scraped posts can be - in days. Putting <code>1</code> will get you only today's posts, <code>2</code> - tomorrow's and today's, and so on. If the <code>Post newer than</code> field was set, the most recent post will be chosen."
194          },
195          "newestPostDate": {
196            "title": "Scrape profile videos older than...",
197            "type": "string",
198            "description": "Optional filter. Only videos uploaded before or on this date will be scraped."
199          },
200          "excludePinnedPosts": {
201            "title": "Exclude pinned posts",
202            "type": "boolean",
203            "description": "Tick to exclude pinned posts from profiles. Pinned posts are usually the first videos on a profile's page.",
204            "default": false
205          },
206          "shouldDownloadVideos": {
207            "title": "Include videos",
208            "type": "boolean",
209            "description": "Tick to download TikTok videos. Note that this will increase time and costs needed to extract the data.",
210            "default": false
211          },
212          "shouldDownloadCovers": {
213            "title": "Include thumbnails",
214            "type": "boolean",
215            "description": "Tick to download TikTok video cover images (thumbnails). Note that this will increase time and costs needed to extract the data.",
216            "default": false
217          },
218          "shouldDownloadSubtitles": {
219            "title": "Include subtitles",
220            "type": "boolean",
221            "description": "Tick to download TikTok video subtitles (only when present on the video). Note that this will increase time and costs needed to extract the data.",
222            "default": false
223          },
224          "shouldDownloadSlideshowImages": {
225            "title": "Download slideshow images",
226            "type": "boolean",
227            "description": "Tick to download TikTok slideshow images. Note that this will increase costs and time required for scraping.",
228            "default": false
229          },
230          "shouldDownloadAvatars": {
231            "title": "Include profile avatars",
232            "type": "boolean",
233            "description": "Tick to download authors' profile pictures. Note that this will increase time and costs needed to extract the data.",
234            "default": false
235          },
236          "videoKvStoreIdOrName": {
237            "title": "✍️ Name your storage for videos",
238            "pattern": "^[a-zA-Z0-9-]+$",
239            "type": "string",
240            "description": "Name (or ID) of the Key Value Store where the videos and other media like thumbnails will be stored. Omit to store in the default one. Using this option will provide a named Key-Value store can help bypass data retention and store the content forever until the store is manually deleted.<br><br>The Key-Value store's name can consist of a versatile combination of uppercase letters, lowercase letters, digits, or hyphens, all without any spaces."
241          }
242        }
243      },
244      "runsResponseSchema": {
245        "type": "object",
246        "properties": {
247          "data": {
248            "type": "object",
249            "properties": {
250              "id": {
251                "type": "string"
252              },
253              "actId": {
254                "type": "string"
255              },
256              "userId": {
257                "type": "string"
258              },
259              "startedAt": {
260                "type": "string",
261                "format": "date-time",
262                "example": "2025-01-08T00:00:00.000Z"
263              },
264              "finishedAt": {
265                "type": "string",
266                "format": "date-time",
267                "example": "2025-01-08T00:00:00.000Z"
268              },
269              "status": {
270                "type": "string",
271                "example": "READY"
272              },
273              "meta": {
274                "type": "object",
275                "properties": {
276                  "origin": {
277                    "type": "string",
278                    "example": "API"
279                  },
280                  "userAgent": {
281                    "type": "string"
282                  }
283                }
284              },
285              "stats": {
286                "type": "object",
287                "properties": {
288                  "inputBodyLen": {
289                    "type": "integer",
290                    "example": 2000
291                  },
292                  "rebootCount": {
293                    "type": "integer",
294                    "example": 0
295                  },
296                  "restartCount": {
297                    "type": "integer",
298                    "example": 0
299                  },
300                  "resurrectCount": {
301                    "type": "integer",
302                    "example": 0
303                  },
304                  "computeUnits": {
305                    "type": "integer",
306                    "example": 0
307                  }
308                }
309              },
310              "options": {
311                "type": "object",
312                "properties": {
313                  "build": {
314                    "type": "string",
315                    "example": "latest"
316                  },
317                  "timeoutSecs": {
318                    "type": "integer",
319                    "example": 300
320                  },
321                  "memoryMbytes": {
322                    "type": "integer",
323                    "example": 1024
324                  },
325                  "diskMbytes": {
326                    "type": "integer",
327                    "example": 2048
328                  }
329                }
330              },
331              "buildId": {
332                "type": "string"
333              },
334              "defaultKeyValueStoreId": {
335                "type": "string"
336              },
337              "defaultDatasetId": {
338                "type": "string"
339              },
340              "defaultRequestQueueId": {
341                "type": "string"
342              },
343              "buildNumber": {
344                "type": "string",
345                "example": "1.0.0"
346              },
347              "containerUrl": {
348                "type": "string"
349              },
350              "usage": {
351                "type": "object",
352                "properties": {
353                  "ACTOR_COMPUTE_UNITS": {
354                    "type": "integer",
355                    "example": 0
356                  },
357                  "DATASET_READS": {
358                    "type": "integer",
359                    "example": 0
360                  },
361                  "DATASET_WRITES": {
362                    "type": "integer",
363                    "example": 0
364                  },
365                  "KEY_VALUE_STORE_READS": {
366                    "type": "integer",
367                    "example": 0
368                  },
369                  "KEY_VALUE_STORE_WRITES": {
370                    "type": "integer",
371                    "example": 1
372                  },
373                  "KEY_VALUE_STORE_LISTS": {
374                    "type": "integer",
375                    "example": 0
376                  },
377                  "REQUEST_QUEUE_READS": {
378                    "type": "integer",
379                    "example": 0
380                  },
381                  "REQUEST_QUEUE_WRITES": {
382                    "type": "integer",
383                    "example": 0
384                  },
385                  "DATA_TRANSFER_INTERNAL_GBYTES": {
386                    "type": "integer",
387                    "example": 0
388                  },
389                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
390                    "type": "integer",
391                    "example": 0
392                  },
393                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
394                    "type": "integer",
395                    "example": 0
396                  },
397                  "PROXY_SERPS": {
398                    "type": "integer",
399                    "example": 0
400                  }
401                }
402              },
403              "usageTotalUsd": {
404                "type": "number",
405                "example": 0.00005
406              },
407              "usageUsd": {
408                "type": "object",
409                "properties": {
410                  "ACTOR_COMPUTE_UNITS": {
411                    "type": "integer",
412                    "example": 0
413                  },
414                  "DATASET_READS": {
415                    "type": "integer",
416                    "example": 0
417                  },
418                  "DATASET_WRITES": {
419                    "type": "integer",
420                    "example": 0
421                  },
422                  "KEY_VALUE_STORE_READS": {
423                    "type": "integer",
424                    "example": 0
425                  },
426                  "KEY_VALUE_STORE_WRITES": {
427                    "type": "number",
428                    "example": 0.00005
429                  },
430                  "KEY_VALUE_STORE_LISTS": {
431                    "type": "integer",
432                    "example": 0
433                  },
434                  "REQUEST_QUEUE_READS": {
435                    "type": "integer",
436                    "example": 0
437                  },
438                  "REQUEST_QUEUE_WRITES": {
439                    "type": "integer",
440                    "example": 0
441                  },
442                  "DATA_TRANSFER_INTERNAL_GBYTES": {
443                    "type": "integer",
444                    "example": 0
445                  },
446                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
447                    "type": "integer",
448                    "example": 0
449                  },
450                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
451                    "type": "integer",
452                    "example": 0
453                  },
454                  "PROXY_SERPS": {
455                    "type": "integer",
456                    "example": 0
457                  }
458                }
459              }
460            }
461          }
462        }
463      }
464    }
465  }
466}