{ "openapi": "3.0.1", "info": { "title": "TikTok Ad Library Scraper", "description": "Scrape ads, discover advertisers, and branded content from TikTok Ad Library.", "version": "0.1", "x-build-id": "gXvUj16GAauParRE5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rastriq~tiktok-ad-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rastriq-tiktok-ad-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/rastriq~tiktok-ad-library-scraper/runs": { "post": { "operationId": "runs-sync-rastriq-tiktok-ad-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/rastriq~tiktok-ad-library-scraper/run-sync": { "post": { "operationId": "run-sync-rastriq-tiktok-ad-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", "properties": { "startUrl": { "title": "TikTok Ad Library URL", "type": "string", "description": "Paste a URL from TikTok Ad Library and the actor will extract all parameters automatically.

Example: https://library.tiktok.com/ads?region=ES&search_key=nike&start_time=...

⚠️ If you use a URL, all manual fields below (query, region, dates…) are ignored. Choose one or the other:
• Paste a URL here → all search config comes from the URL
• Leave this empty → use the manual fields below" }, "mode": { "title": "Scraping mode", "enum": [ "search_ads", "discover_advertisers", "search_commercial_content" ], "type": "string", "description": "Choose what to scrape:
• Search Ads — search paid ads by keyword or advertiser name
• Discover Advertisers — find all advertisers via the suggestion API
• Commercial Content — search branded/organic promotional content", "default": "search_ads" }, "searchQuery": { "title": "Search query", "type": "string", "description": "Type a keyword (e.g. running shoes) or an advertiser name (e.g. Nike).
Leave empty to browse all ads in the selected region.

⚡ Ignored if a URL is provided above." }, "queryType": { "title": "Query type", "enum": [ "keyword", "advertiser" ], "type": "string", "description": "How to interpret the search query.
• Keyword: searches in ad text and titles
• Advertiser name: finds the advertiser's business ID automatically

⚡ Ignored if a URL is provided above.", "default": "keyword" }, "region": { "title": "Region", "enum": [ "all", "AT", "BE", "BG", "CH", "CY", "CZ", "DE", "DK", "EE", "ES", "FI", "FR", "GB", "GR", "HR", "HU", "IE", "IS", "IT", "LI", "LT", "LU", "LV", "MT", "NL", "NO", "PL", "PT", "RO", "SE", "SI", "SK", "TR" ], "type": "string", "description": "Filter ads shown in a specific country. Select 'All regions' to search across all 33 EU/EEA regions.

⚡ Ignored if a URL is provided above.", "default": "all" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of results to return.
Tip: Start with 20 for your first test. TikTok limits searches to ~3,600 ads (300 pages × 12).", "default": 100 }, "startDate": { "title": "Start date", "type": "string", "description": "Only show ads first displayed after this date.
Accepts YYYY-MM-DD or relative like 30 days. Default: 31 days ago.

⚡ Ignored if a URL is provided above." }, "endDate": { "title": "End date", "type": "string", "description": "Only show ads last displayed before this date. Default: today.

⚡ Ignored if a URL is provided above." }, "includeDetails": { "title": "Include ad details", "type": "boolean", "description": "Fetch full details for each ad: advertiser info, targeting by location/age/gender, audience size, and sponsor data.

⚠️ Slower: Makes 1 extra request per ad. Leave OFF for fast runs, enable for rich competitive analysis.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "last_shown_date,desc", "last_shown_date,asc", "first_shown_date,desc", "first_shown_date,asc" ], "type": "string", "description": "Sort order for search results.", "default": "last_shown_date,desc" }, "adIds": { "title": "Ad IDs (direct lookup)", "type": "string", "description": "Paste comma-separated ad IDs to fetch them directly.
Example: 1848459287600130, 1820197122833570

⚡ When provided, all search parameters above are ignored." }, "advertiserIds": { "title": "Advertiser IDs", "type": "string", "description": "Optional comma-separated advertiser business IDs.
Use Discover Advertisers mode to find these, or copy from TikTok Ad Library URLs.

⚡ Ignored if a URL is provided above." }, "discoveryPrefixes": { "title": "Discovery prefixes", "type": "string", "description": "Only for Discover Advertisers mode.
Comma-separated prefixes to search (e.g. a, b, nike, adi).
Leave empty to use full alphabet + digits (slower but comprehensive)." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. The TikTok Ad Library API works without proxy from most locations.
Enable only if you experience rate limiting (HTTP 429)." }, "requestDelay": { "title": "Request delay", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Delay between API requests in milliseconds. Increase to 1000-2000 if you get rate-limited.", "default": 500 } } }, "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 } } } } } } } } } }