{ "openapi": "3.0.1", "info": { "title": "TikTok Ads Scraper", "description": "Scrape TikTok Top Ads from Creative Center by country, industry, objective, ad format and period. Get ad copy, brand, likes, CTR rank, budget level, objective, industry, video and cover URLs, landing page. Export JSON, CSV, Excel.", "version": "1.0", "x-build-id": "fdeaq5ftHMID2WF88" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~tiktok-ads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-tiktok-ads-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/parsebird~tiktok-ads-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-tiktok-ads-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/parsebird~tiktok-ads-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-tiktok-ads-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": { "country": { "title": "Country", "pattern": "^([A-Za-z]{2})?$", "type": "string", "description": "Enter a two-letter market code such as US, GB, DE, JP or BR. Leave empty to search all markets." }, "period": { "title": "Period", "enum": [ "7", "30", "180" ], "type": "string", "description": "Choose the time window the ads are ranked over.", "default": "7" }, "industry": { "title": "Industry", "enum": [ "Apparel & Accessories", "Apps", "Appliances", "Baby, Kids & Maternity", "Beauty & Personal Care", "Business Services", "E-Commerce (Non-app)", "Education", "Financial Services", "Food & Beverage", "Games", "Health", "Home Improvement", "Household Products", "Life Services", "News & Entertainment", "Pets", "Sports & Outdoor", "Tech & Electronics", "Travel", "Vehicle & Transportation" ], "type": "string", "description": "Keep only ads from one industry. Leave empty for all industries." }, "objective": { "title": "Campaign objective", "enum": [ "Traffic", "App Installs", "Conversions", "Video Views", "Reach", "Lead Generation", "Product Sales" ], "type": "string", "description": "Keep only ads that ran with this campaign objective. Leave empty for all objectives." }, "adFormat": { "title": "Ad format", "enum": [ "Spark Ads", "Non-Spark Ads" ], "type": "string", "description": "Spark Ads are boosted posts from a real TikTok account. Leave empty for both." }, "keyword": { "title": "Keyword", "type": "string", "description": "Keep only ads whose ad copy or brand name contains all of these words (whole words, any order, case-insensitive). Leave empty to keep every ad." }, "orderBy": { "title": "Sort by", "enum": [ "For You", "Likes", "CTR", "Impressions", "CVR", "2s View Rate", "6s View Rate" ], "type": "string", "description": "Choose how Creative Center ranks the ads.", "default": "For You" }, "maxResults": { "title": "Max ads", "minimum": 1, "maximum": 500, "type": "integer", "description": "Save at most this many ads (1 to 500). Creative Center may have fewer ads for narrow filters.", "default": 50 }, "responseFormat": { "title": "Response format", "enum": [ "detailed", "concise" ], "type": "string", "description": "Detailed adds landing page, comments, shares, all markets, ad format, tags, HD video and size for every ad. Concise returns the core fields only and finishes faster.", "default": "detailed" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "No proxy is needed for most runs. If TikTok blocks a request, the actor switches to Apify Proxy on its own. Set a proxy here only if you want to control it yourself.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }