{ "openapi": "3.0.1", "info": { "title": "TikTok Ad Library Scraper: Ads, Reach & Targeting", "description": "Get TikTok ads from the official TikTok Ad Library (EU, EEA, UK, Switzerland, Turkey): ad text, video and images, first and last shown, unique users reached per country, landing page, and the age, gender, interest and audience targeting published under the DSA. Search by advertiser or keyword.", "version": "1.0", "x-build-id": "YjJtCigs53dr28tpE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/onibaku~tiktok-ad-library/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-onibaku-tiktok-ad-library", "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/onibaku~tiktok-ad-library/runs": { "post": { "operationId": "runs-sync-onibaku-tiktok-ad-library", "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/onibaku~tiktok-ad-library/run-sync": { "post": { "operationId": "run-sync-onibaku-tiktok-ad-library", "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": "Advertisers or keywords", "type": "array", "description": "What you'd type in the library's search box: an advertiser name or keyword (nike), or an exact phrase in quotes (\"just do it\"). For one advertiser's ads only, paste its library search URL (every result has it as advertiserAdsUrl). Any library.tiktok.com/ads URL works.", "items": { "type": "string" } }, "region": { "title": "Country", "type": "string", "description": "Where the ads were shown: an EU or EEA country code (DE, FR, NL...), GB, CH or TR, or \"all\". The library only covers these countries.", "default": "all" }, "startDate": { "title": "Shown on or after", "type": "string", "description": "YYYY-MM-DD. Defaults to 30 days before the end date." }, "endDate": { "title": "Shown on or before", "type": "string", "description": "YYYY-MM-DD. Defaults to today." }, "format": { "title": "Ad format", "enum": [ "all", "video", "image", "text" ], "type": "string", "description": "Only ads in this format.", "default": "all" }, "status": { "title": "Ad status", "enum": [ "all", "active", "inactive" ], "type": "string", "description": "Only ads that are still running, or only ones that have stopped.", "default": "all" }, "sortBy": { "title": "Sort by", "enum": [ "lastShown", "published", "reach" ], "type": "string", "description": "Order the library returns ads in.", "default": "lastShown" }, "includeDetails": { "title": "Include targeting and landing page", "type": "boolean", "description": "One extra lookup per ad for the advertiser's details, landing page, unique users per country and the targeting (age, gender, interests, audience size). Turn off for faster runs.", "default": true }, "maxResultsPerQuery": { "title": "Max ads per search", "minimum": 1, "type": "integer", "description": "Stop after this many ads from any one search.", "default": 200 }, "maxResults": { "title": "Max ads in total", "minimum": 1, "type": "integer", "description": "Stop after this many ads in total.", "default": 1000 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "TikTok shows each IP only a few ad details at a time, so the actor moves between Apify Proxy sessions. Keep this on.", "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 }, "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 } } } } } } } } } }