{
  "openapi": "3.0.1",
  "info": {
    "title": "TikTok Scraper - Videos, Transcripts, Profiles & Creator Leads",
    "description": "Scrape TikTok videos, transcripts with timestamps, creator profiles, reposts, playlists, sounds and keyword searches with no login: follower and engagement stats, bios, music, plus emails and social handles for creator leads with a 0-100 score. Date and engagement filters. Pay per result.",
    "version": "0.1",
    "x-build-id": "fIMY6TQa6fnnWE3um"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~tiktok-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-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/scrapesage~tiktok-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-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/scrapesage~tiktok-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-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",
        "properties": {
          "profiles": {
            "title": "TikTok profiles (no login needed)",
            "type": "array",
            "description": "TikTok usernames or profile URLs. Accepts '@tiktok', 'tiktok' or 'https://www.tiktok.com/@tiktok'. Each yields one rich profile/creator record: follower/like/video counts, bio, language, verified & business flags, bio link, e-mail & social handles extracted from the bio, and a 0-100 lead score. Works without any login.",
            "items": {
              "type": "string"
            }
          },
          "videoUrls": {
            "title": "Video URLs (no login needed)",
            "type": "array",
            "description": "Specific TikTok video URLs (or IDs) for full detail: description, hashtags, play/like/comment/share/save counts, duration, cover image, music title & author, and the creator's stats. Accepts 'https://www.tiktok.com/@user/video/123...', a share link like 'https://vm.tiktok.com/...' or a bare numeric video ID. Works without any login.",
            "items": {
              "type": "string"
            }
          },
          "hashtags": {
            "title": "Hashtags (no login, videos that carry the tag)",
            "type": "array",
            "description": "Hashtag names or URLs. Accepts 'cooking', '#cooking' or 'https://www.tiktok.com/tag/cooking'. Returns videos that really carry the tag, read from TikTok's public keyword pages. TikTok keeps its full hashtag feed behind its own bot check for logged-out visitors, so this is the tagged videos those pages list, not every video under the hashtag. Rows without the tag are not delivered or billed. A topic with no public page returns nothing and is not billed; the run card says so.",
            "items": {
              "type": "string"
            }
          },
          "searchQueries": {
            "title": "Search keywords (no login needed)",
            "type": "array",
            "description": "Keywords. Returns videos (or the creators behind them, see 'Search type'), up to 'Max items' per keyword, from TikTok's public keyword page for that phrase and then its related pages when you ask for more. Each row's 'matchedKeyword' names the page it came from. Most popular phrases have a page ('cooking recipes', 'electric cars') but not every word does ('fitness' has none): a keyword with no page returns nothing, is not billed, and the run card lists TikTok's own suggestions.",
            "items": {
              "type": "string"
            }
          },
          "searchType": {
            "title": "Search type",
            "enum": [
              "video",
              "user"
            ],
            "type": "string",
            "description": "What each search keyword returns: videos, or the creators behind those videos (each read in full and delivered as a profile record).",
            "default": "video"
          },
          "maxItems": {
            "title": "Max items (videos / creators / comments)",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of list items (videos, search results or comments) to return per input source. Profile and single-video-URL records are always returned and do not count against this. Set 0 for no limit (the run still self-stops before the platform time limit and returns what it has).",
            "default": 100
          },
          "maxVideosPerProfile": {
            "title": "Videos per profile (no login needed)",
            "minimum": 0,
            "type": "integer",
            "description": "For each profile, how many of its most recent videos to also scrape, newest first. 0 = the profile record only. Also limited by 'Max items'. Each video is billed as one Video. Private accounts show no videos; the run card names them.",
            "default": 0
          },
          "includeVideoDetails": {
            "title": "Include full video details",
            "type": "boolean",
            "description": "Also open each listed video's own page, which adds the country it was posted from and, where TikTok lists them, its topic labels and related searches. Slower, no extra charge. Off by default because a listed video already carries its description, all engagement counts, duration, cover, music and hashtags.",
            "default": false
          },
          "includeTranscripts": {
            "title": "Include video transcripts",
            "type": "boolean",
            "description": "Add each video's transcript from the captions TikTok publishes for it: the full text and timed lines (about two videos in three have them). Billed per transcript on top of the video, free until 21 November 2026. A video with no captions ships without one and is not billed for it.",
            "default": false
          },
          "maxRepostsPerProfile": {
            "title": "Reposts per profile (no login needed)",
            "minimum": 0,
            "type": "integer",
            "description": "For each profile, how many of the videos it reposted to also scrape. 0 = none. Also limited by 'Max items'. Each video is billed as one Video.",
            "default": 0
          },
          "musicUrls": {
            "title": "Sounds (no login needed)",
            "type": "array",
            "description": "TikTok sound links like 'https://www.tiktok.com/music/name-7000000000000000000', or the numeric sound ID. Returns the videos TikTok lists for that sound, about 30 at most. Each video is billed as one Video.",
            "items": {
              "type": "string"
            }
          },
          "playlistUrls": {
            "title": "Playlists (no login needed)",
            "type": "array",
            "description": "TikTok playlist links like 'https://www.tiktok.com/@user/playlist/name-7000000000000000000', or the numeric playlist ID. Returns the playlist's videos. Each video is billed as one Video.",
            "items": {
              "type": "string"
            }
          },
          "oldestVideoDate": {
            "title": "Oldest video date",
            "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$",
            "type": "string",
            "description": "Only videos posted on or after this date: a date (YYYY-MM-DD) or a period back from the run, such as \"30 days\". Filters feeds, reposts, sounds, playlists, hashtags and keyword pages; a video you list by URL is always returned. Videos left out are not billed."
          },
          "newestVideoDate": {
            "title": "Newest video date",
            "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$",
            "type": "string",
            "description": "Only videos posted on or before this date: a date (YYYY-MM-DD) or a period back from the run, such as \"7 days\". Same reach as the oldest date. Videos left out are not billed."
          },
          "minPlays": {
            "title": "Minimum plays",
            "minimum": 0,
            "type": "integer",
            "description": "Only videos with at least this many plays. 0 = no minimum. Same reach as the date filters. Videos left out are not billed."
          },
          "minLikes": {
            "title": "Minimum likes",
            "minimum": 0,
            "type": "integer",
            "description": "Only videos with at least this many likes. 0 = no minimum. Same reach as the date filters. Videos left out are not billed."
          },
          "commentsPerVideo": {
            "title": "Comments per video (needs your login cookie, or a data-provider key)",
            "minimum": 0,
            "type": "integer",
            "description": "How many top comments to try to read per video in 'Video URLs'. 0 = no comments. TikTok keeps comment lists behind its own bot check for logged-out visitors. Add your own TikTok login cookie below (free) and the run reads comments as your logged-in session; a data-provider key is an optional fallback. TikTok can still refuse a given video. Comments are billed only when delivered, and the run card says what happened.",
            "default": 0
          },
          "sessionCookie": {
            "title": "Your TikTok login cookie (free way to get comments, full hashtag feeds & search)",
            "type": "string",
            "description": "The free way to unlock comments, the full hashtag feed and keyword search: paste your own TikTok 'sessionid' value (or a full cookie string like 'sessionid=...; tt_csrf_token=...') and the run makes TikTok's logged-in calls as you. Profiles, video feeds, single videos, sounds, playlists, reposts, transcripts and the public keyword/hashtag pages all work WITHOUT it; the cookie only adds the three calls TikTok gates for logged-out visitors. TikTok can still refuse a given call: the run card says so and nothing is billed for what is not delivered. Your cookie is sent only to tiktok.com on those calls, never anywhere else. Get it from your browser's DevTools > Application > Cookies on tiktok.com while logged in. It is tied to your account, so treat it like a password and use an account you are comfortable automating."
          },
          "supplierApiKey": {
            "title": "Data-provider API key (optional fallback for comments & full hashtag feeds)",
            "type": "string",
            "description": "Optional fallback for when you would rather not use your own login cookie above. Paste a ScrapeCreators API key (scrapecreators.com, free credits to start, no card) and the run reads comments for your Video URLs and the full feed for your Hashtags through it, billed as Comment and Video. The login cookie above is tried first; this key is used only when no cookie is given or the cookie returns nothing. Treat it like a password."
          },
          "enrichBioLink": {
            "title": "Enrich bio link (creator leads)",
            "type": "boolean",
            "description": "For each profile, crawl the creator's bio link (Linktree, Beacons, business site, etc.) for publicly listed e-mail addresses, phone numbers and social profiles - turning a creator into an outreach-ready lead. Billed as an 'Enriched creator lead' add-on, only when the bio link adds a contact the profile lacked.",
            "default": false
          },
          "monitorMode": {
            "title": "Monitor mode (only new items)",
            "type": "boolean",
            "description": "Remember items seen on previous runs (in a named key-value store) and emit only NEW videos/profiles on later runs. Ideal for scheduled tracking of a creator or keyword.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor store name",
            "type": "string",
            "description": "Named key-value store that holds the 'seen' fingerprints for monitor mode. Leave blank to use a default store per run source."
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Defaults to Apify's standard proxy pool, which TikTok serves and which is the cheapest. Pick RESIDENTIAL only if a run reports refusals. You may also bring your own proxy URLs.",
            "default": {
              "useApifyProxy": true
            }
          },
          "headful": {
            "title": "Headful browser (no longer used)",
            "type": "boolean",
            "description": "This Actor no longer starts a browser. The field stays so older saved inputs keep working, and it changes nothing.",
            "default": true
          },
          "debugMode": {
            "title": "Debug mode",
            "type": "boolean",
            "description": "Save a short summary of each profile page's data blocks to the key-value store for troubleshooting. Leave off for normal runs.",
            "default": false
          },
          "urlsFromFile": {
            "title": "Import URLs from a file",
            "type": "string",
            "description": "Paste a list of TikTok URLs (one per line), OR one link to a .txt/.csv file, Google Sheet or Google Drive file containing them. Profile, video, sound, playlist, hashtag and keyword links each go where they belong. Google Sheet/Drive share links are handled automatically."
          }
        }
      },
      "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}