{ "openapi": "3.0.1", "info": { "title": "TikTok Ad Library Scraper — Resume & $0-on-Block", "description": "Get TikTok ads from the EU Commercial Content Library (DSA archive, searchable by advertiser) or Creative Center Top Ads (global high-performers with CTR/like metrics). Resumable; never charges for blocked or rate-limited runs.", "version": "1.2", "x-build-id": "31mhP8Xl93enZJJwb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/domestic_buffalograss~tiktok-ad-library-reliable/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-domestic_buffalograss-tiktok-ad-library-reliable", "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/domestic_buffalograss~tiktok-ad-library-reliable/runs": { "post": { "operationId": "runs-sync-domestic_buffalograss-tiktok-ad-library-reliable", "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/domestic_buffalograss~tiktok-ad-library-reliable/run-sync": { "post": { "operationId": "run-sync-domestic_buffalograss-tiktok-ad-library-reliable", "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": [ "queries" ], "properties": { "queries": { "title": "Advertiser names / keywords", "type": "array", "description": "Advertiser names or keywords to search for (used by the EU library surface; Creative Center Top Ads is a browse-only feed without keyword search).", "items": { "type": "string" } }, "surfaces": { "title": "Surfaces", "type": "array", "description": "Where to fetch ads from. 'ccl' = EU Commercial Content Library (all EU-delivered ads, DSA archive, searchable, includes audience estimates). 'cc' = Creative Center Top Ads (browse feed of ~top 20 high-performing ads per country with CTR/like metrics; no keyword filter).", "items": { "type": "string", "enum": [ "ccl", "cc" ], "enumTitles": [ "EU Commercial Content Library (all EU ads)", "Creative Center Top Ads (global samples + metrics)" ] }, "default": [ "ccl" ] }, "countries": { "title": "Countries", "type": "array", "description": "For CCL: ISO code of the ad target country, or 'all' for all countries. For Creative Center: ISO code ('all' falls back to US).", "default": [ "all" ], "items": { "type": "string" } }, "lookbackDays": { "title": "Lookback window (days, CCL)", "minimum": 1, "maximum": 365, "type": "integer", "description": "How far back to search by last-shown date (CCL surface). Max 365 (DSA archive keeps ~12 months).", "default": 365 }, "mode": { "title": "Mode", "enum": [ "snapshot", "snapshot_with_media" ], "type": "string", "description": "'snapshot' fetches ad records only. 'snapshot_with_media' also downloads creative files to key-value storage.", "default": "snapshot" }, "maxItems": { "title": "Max ads (hard cap)", "minimum": 1, "type": "integer", "description": "Hard cap on billable ads. You are never charged for more than this many ads across the whole run (including resumes).", "default": 500 }, "maxAdsPerUnit": { "title": "Max ads per query×country", "minimum": 12, "maximum": 5000, "type": "integer", "description": "Cap of ads fetched per (surface × query × country) work unit.", "default": 600 }, "ccPeriodDays": { "title": "Creative Center period (days)", "minimum": 7, "maximum": 180, "type": "integer", "description": "Top Ads ranking window for the Creative Center surface (7/30/180).", "default": 30 }, "maxBudgetUsd": { "title": "Max budget (USD, optional)", "minimum": 0, "type": "number", "description": "Optional hard USD ceiling. The run stops before exceeding it, and the ceiling persists across resumes. Leave empty for no cap; 0 means charge nothing." }, "useResidentialProxy": { "title": "Use residential proxy", "type": "boolean", "description": "Off by default (TikTok libraries are reachable from datacenter egress). Turn on only if your runs get blocked.", "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 } } }, "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 } } } } } } } } } }