{ "openapi": "3.0.1", "info": { "title": "TikTok Creative Center Top Ads Scraper", "description": "Scrape TikTok's best-performing ads from the TikTok Creative Center Top Ads. Get ad videos, titles, brands, CTR, likes, landing pages, industries, objectives and the countries each ad ran in. Filter by country, industry, objective, language and period. No login.", "version": "0.1", "x-build-id": "fsyFR9HoBd4XXdhZN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jmlp~tiktok-creative-center-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jmlp-tiktok-creative-center-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/jmlp~tiktok-creative-center-scraper/runs": { "post": { "operationId": "runs-sync-jmlp-tiktok-creative-center-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/jmlp~tiktok-creative-center-scraper/run-sync": { "post": { "operationId": "run-sync-jmlp-tiktok-creative-center-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": { "countries": { "title": "Countries", "type": "array", "description": "Where the ads ran: ISO codes or names (US, United Kingdom, Deutschland). Top Ads covers AR, AU, BR, CA, CO, FR, DE, ID, IT, JP, MY, MX, NL, PK, PH, RO, SA, SG, ZA, KR, ES, SE, TH, TR, AE, GB, US and VN. Empty means all of them.", "items": { "type": "string" } }, "period": { "title": "Period", "type": "string", "description": "How far back the ranking looks.", "default": "30" }, "sortBy": { "title": "Rank by", "type": "array", "description": "Each ranking is its own top list, so several give more ads: for you (TikTok's default), likes, ctr, reach, conversion rate, 6s view rate, 2s view rate - or 'all'.", "items": { "type": "string" } }, "industries": { "title": "Industries", "type": "array", "description": "Names as the Creative Center shows them, matched loosely: 'beauty' finds Beauty & Personal Care. A category covers its sub-industries. Empty means every industry.", "items": { "type": "string" } }, "objectives": { "title": "Campaign objectives", "type": "array", "description": "Any of: traffic, app installs, conversions, video views, reach, lead generation, product sales. Empty means every objective.", "items": { "type": "string" } }, "adLanguages": { "title": "Ad languages", "type": "array", "description": "Codes or names: en, es, ar, vi, th, de, id, pt, fr, ms, nl, ja, it, ro, zh-Hant, ko. Empty means every language.", "items": { "type": "string" } }, "maxAds": { "title": "Max ads", "type": "integer", "description": "Stop after this many unique ads. Each query returns up to 20 - TikTok's limit for a signed-out visitor - and more countries, industries, objectives or rankings mean more queries. Empty means every ad the queries return." }, "maxQueries": { "title": "Max queries", "type": "integer", "description": "A cap on the number of country x industry x objective x language x ranking combinations. Each returns up to 20 ads.", "default": 500 }, "scrapeAdDetails": { "title": "Scrape ad details", "type": "boolean", "description": "Open each ad's detail for its landing page, every country it ran in, comments, shares and keywords. One extra request per ad.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. If TikTok refuses the run's exits, it moves to new ones and finally tries a residential proxy.", "default": { "useApifyProxy": true } }, "resume": { "title": "Checkpoint progress", "type": "boolean", "description": "Save progress every ~30s so a run that gets migrated or restarted picks up where it stopped.", "default": true }, "continueFromLastRun": { "title": "Continue from last run", "type": "boolean", "description": "If your previous run with the same input was interrupted, run only the queries it missed.", "default": false } } }, "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 } } } } } } } } } }