{ "openapi": "3.0.1", "info": { "title": "TikTok Trending Videos Scraper", "description": "Collect TikTok videos trending in the US, Japan, Vietnam, Thailand, or Indonesia. Rank the trending list by views, engagement rate, or six-second view rate for the last 7 or 30 days. Each video includes its creator, sound, and link, and no TikTok login is needed.", "version": "0.0", "x-build-id": "dIjOVXNODeplvf7hs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~tiktok-trending-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-tiktok-trending-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/maximedupre~tiktok-trending-scraper/runs": { "post": { "operationId": "runs-sync-maximedupre-tiktok-trending-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/maximedupre~tiktok-trending-scraper/run-sync": { "post": { "operationId": "run-sync-maximedupre-tiktok-trending-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": [ "resultType" ], "properties": { "resultType": { "title": "Result type", "enum": [ "videos" ], "type": "string", "description": "Videos collects TikTok videos from the markets you pick, using the source you choose under Find videos by. Videos is the only option." }, "markets": { "title": "Markets", "minItems": 1, "type": "array", "description": "Type a two-letter country code and press Enter. Add more codes to collect videos from several markets in one run. Valid codes: US (United States), JP (Japan), VN (Vietnam), TH (Thailand), and ID (Indonesia). A code outside this list stops the run from starting. If you leave this field out of an API run, the run uses the United States.", "items": { "type": "string", "pattern": "^([Uu][Ss]|[Jj][Pp]|[Vv][Nn]|[Tt][Hh]|[Ii][Dd])$" }, "default": [ "US" ] }, "discoveryMethod": { "title": "Find videos by", "enum": [ "trending-list", "for-you-feed", "explore-feed" ], "type": "string", "description": "Trending list collects the videos TikTok ranks in each market. For You feed collects videos from TikTok's For You feed in each market. Explore feed collects videos from TikTok's Explore trending feed in each market.", "default": "trending-list" }, "rankBy": { "title": "Rank videos by", "enum": [ "views", "engagement-rate", "six-second-view-rate" ], "type": "string", "description": "Trending list only. Sets the order of the trending video list. For You feed and Explore feed videos ignore it.", "default": "views" }, "timeWindow": { "title": "Time window", "enum": [ "7-days", "30-days" ], "type": "string", "description": "Trending list only. Sets the period the trends cover: the last 7 days or the last 30 days.", "default": "7-days" }, "category": { "title": "Category", "enum": [ "Beauty & Care", "Family & Relationship", "Fashion", "Food & Beverage", "Games", "Lifestyle & Leisure", "Music & Entertainment", "Nature & Animals", "Society", "Sports & Outdoor", "Technology & Finance", "Vehicles & Transportation", "Vlog & Selfie" ], "type": "string", "description": "Optional. Choose one category to keep only results in that category. Trending list only. Leave empty to include every category." }, "maxItems": { "title": "Maximum results", "minimum": 1, "type": "integer", "description": "Optional. Stops the run after this many results. With several markets, the limit counts results from all of them together. Leave empty to return all available results until the source is exhausted. With Find videos by set to Trending list, TikTok shows only a few top videos for each market, sort order, and time window. A higher limit may return fewer videos than you ask for." } } }, "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 } } } } } } } } } }