{ "openapi": "3.0.1", "info": { "title": "TikTok Ads Library Scraper", "description": "Scrape the TikTok Ads Library: every ad shown in the EU, UK and Turkey with advertiser, first and last shown dates, video links, audience size and targeting. Just pick regions and dates. No login. Export to Excel, CSV or JSON, or use the API.", "version": "0.1", "x-build-id": "TQ933APxRxqTkBse9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automly~tiktok-ads-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automly-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/automly~tiktok-ads-library-scraper/runs": { "post": { "operationId": "runs-sync-automly-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/automly~tiktok-ads-library-scraper/run-sync": { "post": { "operationId": "run-sync-automly-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": [ "regions", "startDate", "endDate" ], "properties": { "regions": { "title": "Regions", "type": "array", "description": "Two-letter country codes, e.g. DE, FR or GB, or all for every region. TikTok's Ads Library covers EU countries, the UK, Switzerland, Norway, Iceland, Liechtenstein and Turkey.", "default": [ "all" ], "items": { "type": "string" } }, "startDate": { "title": "Start date", "type": "string", "description": "First day the ads were shown, as YYYY-MM-DD, e.g. 2025-01-01." }, "endDate": { "title": "End date", "type": "string", "description": "Last day the ads were shown, as YYYY-MM-DD, e.g. 2025-12-31. Must be after the start date." }, "query": { "title": "Search query", "type": "string", "description": "Optional words to find in the advertiser name or ad text, e.g. nike.", "default": "" }, "advertiserBusinessIds": { "title": "Advertiser business IDs", "type": "array", "description": "Optional TikTok advertiser IDs to limit the results to, one per line.", "default": [], "items": { "type": "string" } }, "adType": { "title": "Ad type", "enum": [ "all", "video", "image" ], "type": "string", "description": "Filter by creative type.", "default": "all" }, "sortOrder": { "title": "Sort order", "enum": [ "last_shown_date,desc", "last_shown_date,asc", "first_shown_date,desc", "first_shown_date,asc" ], "type": "string", "description": "Sort results by date field and order.", "default": "last_shown_date,desc" }, "maxResults": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Most ads to return in the whole run, e.g. 100.", "default": 1000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. The default works for most runs. If results come back empty, try a different proxy option." }, "fetchDetails": { "title": "Fetch per-ad details", "type": "boolean", "description": "Add advertiser sponsor, targeting (age/gender per region), target audience size, call to action, landing page link and campaign objective to each ad. The ad text comes with every ad either way. Makes larger runs noticeably longer.", "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 }, "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 } } } } } } } } } }