{
  "openapi": "3.0.1",
  "info": {
    "title": "TikTok Scraper: Profiles, Videos, Hashtags, Search & Comments",
    "description": "One actor for TikTok instead of seven. Pick a mode and pass a list: accounts and their posts, a single post in full detail, a hashtag's video feed, keyword search, a video's comments with replies, or account discovery by keyword. Video rows share one shape across every mode. No login, no cookies.",
    "version": "0.0",
    "x-build-id": "45ybInw7cISDChEAc"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/memo23~tiktok-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-memo23-tiktok-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/memo23~tiktok-scraper/runs": {
      "post": {
        "operationId": "runs-sync-memo23-tiktok-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/memo23~tiktok-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-memo23-tiktok-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "required": [
          "mode",
          "input"
        ],
        "properties": {
          "mode": {
            "title": "What to scrape",
            "enum": [
              "profile",
              "videos",
              "post",
              "hashtag",
              "search",
              "comments",
              "users"
            ],
            "type": "string",
            "description": "Which job to run. This decides what the \"input\" list below means. profile: usernames in, account details out. videos: usernames in, that account's posts out. post: post URLs or IDs in, one detailed row each. hashtag: hashtags in, the videos in each feed out. search: keywords in, matching videos out. comments: video URLs or IDs in, their comments out. users: keywords in, matching accounts out.",
            "default": "profile"
          },
          "input": {
            "title": "Input list",
            "type": "array",
            "description": "What to scrape. The meaning follows the mode you picked. For profile and videos, usernames or profile URLs such as \"@gymshark\" or \"https://www.tiktok.com/@gymshark\". For post and comments, post URLs or bare IDs such as \"https://www.tiktok.com/@gymshark/video/7660964717631999254\" or \"7660964717631999254\"; short vm.tiktok.com links are resolved for you. For hashtag, tags such as \"#coffee\" or \"coffee\". For search and users, plain keywords such as \"latte art\".",
            "items": {
              "type": "string"
            }
          },
          "maxResults": {
            "title": "Maximum results per input",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "How many rows to collect for each entry in the list above. Applies to hashtag, search, users and comments. The exact number is honoured rather than rounded up to a page boundary, so asking for 37 returns 37. Default 100.",
            "default": 100
          },
          "includeVideos": {
            "title": "Also fetch posts (profile mode)",
            "type": "boolean",
            "description": "Profile mode only. Adds that account's posts after its profile row. Leave off for a fast account lookup. Default false.",
            "default": false
          },
          "maxVideosPerProfile": {
            "title": "Posts per account",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "How many posts to collect per account in videos mode, or in profile mode when \"Also fetch posts\" is on. Up to 33 comes from a single cheap request; anything above that pages a second, slower source. Default 100.",
            "default": 100
          },
          "strictHashtagMatch": {
            "title": "Only posts actually carrying the tag (hashtag mode)",
            "type": "boolean",
            "description": "Hashtag mode only. TikTok's hashtag feed is a related-content feed, not a tag index: a #coffee run also returns posts tagged only #coffeetok. Measured on a live feed, 23 of 37 posts carried the requested tag. Turn this on to drop the rest, which matters for tag-share analysis. Default false.",
            "default": false
          },
          "minFollowers": {
            "title": "Minimum followers (users mode)",
            "minimum": 0,
            "type": "integer",
            "description": "Users mode only. Skip accounts below this follower count. Combine with the maximum to target a size band, for example 10000 to 100000 for mid-tier creators. Default 0, meaning no lower limit.",
            "default": 0
          },
          "maxFollowers": {
            "title": "Maximum followers (users mode)",
            "minimum": 0,
            "type": "integer",
            "description": "Users mode only. Skip accounts above this follower count. Useful for finding smaller creators rather than the household names that dominate search results. Leave empty for no upper limit."
          },
          "verifiedOnly": {
            "title": "Verified accounts only (users mode)",
            "type": "boolean",
            "description": "Users mode only. Return just accounts carrying TikTok's verification badge. Default false.",
            "default": false
          },
          "includeReplies": {
            "title": "Also fetch replies (comments mode)",
            "type": "boolean",
            "description": "Comments mode only. Adds reply rows under each top-level comment that has any. Reply rows carry isReply true and the parentCommentId they belong to. Default false.",
            "default": false
          },
          "maxRepliesPerComment": {
            "title": "Replies per comment",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Comments mode only, and only when replies are on. Caps how many replies to collect under each comment. Default 50.",
            "default": 50
          },
          "includeMediaUrls": {
            "title": "Include media URLs (post mode)",
            "type": "boolean",
            "description": "Post mode only. Adds the video file URL, cover image, music URL, and for slideshows the list of image URLs. Default true.",
            "default": true
          },
          "includeAuthorStats": {
            "title": "Include author stats (post mode)",
            "type": "boolean",
            "description": "Post mode only. Adds the author's bio, avatar, follower, following, like and video counts to each post row. Default true.",
            "default": true
          },
          "includeHashtagsMentions": {
            "title": "Include hashtags and mentions (post mode)",
            "type": "boolean",
            "description": "Post mode only. Adds the post's hashtags and @-mentions, read from TikTok's structured data and falling back to parsing the caption when that data is missing. Default true.",
            "default": true
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}