{ "openapi": "3.0.1", "info": { "title": "TikTok Ads Library Scraper", "description": "Scrape the TikTok Ads Library: advertisers, creatives, reach and DSA targeting data across the EU, EEA and UK.", "version": "1.0", "x-build-id": "ASEAqWufeS6jwjkO3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datascoutlab~tiktok-ads-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datascoutlab-tiktok-ads-library-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/datascoutlab~tiktok-ads-library-scraper/runs": { "post": { "operationId": "runs-sync-datascoutlab-tiktok-ads-library-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/datascoutlab~tiktok-ads-library-scraper/run-sync": { "post": { "operationId": "run-sync-datascoutlab-tiktok-ads-library-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": [ "searchTerms" ], "properties": { "regions": { "title": "Countries", "type": "array", "description": "Two-letter country codes. The TikTok Ads Library exists because of the EU Digital Services Act, so it covers the EU-27, EEA (IS, LI, NO), Switzerland, the UK and Türkiye. Codes outside that list are skipped with a warning rather than failing the run.", "default": [ "DE" ], "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Advertiser names to search, one per line. Each term is searched separately in each country. At least one term is required — TikTok's library returns nothing for an empty query.", "items": { "type": "string" } }, "searchBy": { "title": "Match mode", "enum": [ "broad", "exact" ], "type": "string", "description": "`Exact advertiser` matches the registered company name in full (\"NIKE Retail B.V.\") and returns that advertiser's complete ad set — far more ads and no unrelated accounts. `Broad` matches any advertiser whose name contains your text, which is what you want when you don't know the exact legal name.", "default": "broad" }, "advertiserIds": { "title": "Advertiser business ID", "type": "string", "description": "Optional. Pins the search to one exact advertiser, avoiding name collisions. You get this ID as `advertiserBusinessId` in any previous run." }, "daysBack": { "title": "Days back", "minimum": 1, "maximum": 3650, "type": "integer", "description": "How far back to look, counting from today. Ignored when you set an explicit start and end date below.", "default": 30 }, "startDate": { "title": "Start date", "type": "string", "description": "Optional exact window start, `YYYY-MM-DD`. Set both start and end to override `Days back`." }, "endDate": { "title": "End date", "type": "string", "description": "Optional exact window end, `YYYY-MM-DD`." }, "sortBy": { "title": "Sort by", "enum": [ "last_shown_date,desc", "last_shown_date,asc", "impression,desc", "impression,asc" ], "type": "string", "description": "`Most recently shown` follows the library default. Sorting by reach puts the ads that actually got impressions on top — usually what you want when researching what works.", "default": "last_shown_date,desc" }, "includeDetails": { "title": "Include ad copy and targeting", "type": "boolean", "description": "On by default, and the main reason to use this Actor. Adds the ad text, call to action, landing page, the advertiser's TikTok account with follower count, and the DSA targeting breakdown — impressions per country split by age and gender. Costs one extra request per ad.", "default": true }, "maxResultsPerQuery": { "title": "Max ads per country and term", "minimum": 1, "maximum": 3600, "type": "integer", "description": "Upper bound for each country and term combination. You are billed per ad returned, so this is also your cost ceiling. TikTok serves results in pages of 12.", "default": 120 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Datacenter proxies are enough — the Ads Library answers from any region, so residential proxies only add cost.", "default": { "useApifyProxy": 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 } } } } } } } } } }