{ "openapi": "3.0.1", "info": { "title": "Tiktok Ads", "description": "Extract TikTok ads by keyword, advertiser, or ID. Get creatives, CTR, targeting & reach data. Export to JSON/CSV/Excel. No login required.", "version": "0.0", "x-build-id": "EesN1sOJypCkga0o0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devil_port369-owner~tiktok-ads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devil_port369-owner-tiktok-ads", "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/devil_port369-owner~tiktok-ads/runs": { "post": { "operationId": "runs-sync-devil_port369-owner-tiktok-ads", "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/devil_port369-owner~tiktok-ads/run-sync": { "post": { "operationId": "run-sync-devil_port369-owner-tiktok-ads", "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": [ "startDate", "endDate" ], "properties": { "query": { "title": "Search Query", "type": "string", "description": "Keyword, brand name, or domain to search for ads. E.g. 'Nike', 'netflix.com', or 'fitness app'. Use specific brand names for best results — generic terms may return 0 results." }, "region": { "title": "Region / Country", "enum": [ "all", "US", "GB", "AU", "CA", "IN", "BR", "MX", "JP", "KR", "DE", "FR", "IT", "ES", "NL", "PL", "SE", "NO", "DK", "FI", "AT", "BE", "BG", "CY", "CZ", "EE", "GR", "HR", "HU", "IE", "LT", "LU", "LV", "MT", "PT", "RO", "SI", "SK", "CH", "ID", "TH", "PH", "VN", "SG", "MY", "ZA", "AE", "SA" ], "type": "string", "description": "Target country code for the ad search. Use 'all' to scrape globally." }, "startDate": { "title": "Start Date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Filter ads shown on or after this date. Format: YYYY-MM-DD. Defaults to 1 year ago if omitted." }, "endDate": { "title": "End Date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Filter ads shown on or before this date. Format: YYYY-MM-DD. Defaults to today if omitted." }, "order": { "title": "Sort Order", "enum": [ "last_shown_date,desc", "last_shown_date,asc", "create_time,desc", "create_time,asc", "impressions,asc", "impressions,desc" ], "type": "string", "description": "Sort ads by a field and direction. 'last_shown_date,desc' returns the most recently active ads first." }, "limit": { "title": "Max Ads to Scrape", "minimum": 12, "maximum": 100000, "type": "integer", "description": "Maximum number of ads to extract per run. Set to 0 for no limit (scrapes all available results). Creative Center returns up to 400 ads per filter combination." }, "resolveAdDetails": { "title": "Resolve Full Ad Details", "type": "boolean", "description": "When enabled, the actor fetches full detail pages for each ad to unlock additional fields: reach estimates, targeting demographics (age, gender, interests), and audience size. Increases run time and cost." } } }, "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 } } } } } } } } } }