{ "openapi": "3.0.1", "info": { "title": "Tiktok One Scraper", "description": "All In One for TikTok One Top Ads research. Extract structured data from official Top Ads Insight and Top Ads Library workflows, including overview metrics, creative approaches, selling point analysis, material lists, library search results, and material details.", "version": "0.1", "x-build-id": "XQ4gtHmCrBu3m9e55" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/doliz~tiktok-one-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-doliz-tiktok-one-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/doliz~tiktok-one-scraper/runs": { "post": { "operationId": "runs-sync-doliz-tiktok-one-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/doliz~tiktok-one-scraper/run-sync": { "post": { "operationId": "run-sync-doliz-tiktok-one-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", "required": [ "target", "cookies" ], "properties": { "target": { "title": "Target", "enum": [ "top_ads_insight", "top_ads_insight_creative_approach", "top_ads_insight_selling_point_analysis", "top_ads_insight_top20_selling_points", "top_ads_insight_formula_material_list", "top_ads_insight_selling_point_material_list", "top_ads_insight_material_detail", "top_ads_library", "top_ads_library_material_detail" ], "type": "string", "description": "Select a TikTok One data source.", "default": "top_ads_insight" }, "cookies": { "title": "Cookies", "type": "string", "description": "Your TikTok One authentication cookies. Way to obtain: ![](https://github.com/lofe-w/tiktok-one-scraper-public/raw/main/imgs/get_cookie.png)", "default": "Your cookies" }, "insight_industry_label": { "title": "Industry label", "enum": [ "18000000000", "14000000000", "22000000000", "29000000000", "16000000000", "28000000000", "20000000000" ], "type": "string", "description": "Official industry label for Top Ads Insight. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_industry.json)", "default": "18000000000" }, "insight_country_code": { "title": "Country code", "enum": [ "", "US", "JP", "ID", "TH", "MY", "VN", "GB", "FR", "PH", "SA", "ZA", "KR", "ES", "MX" ], "type": "string", "description": "Official country or region filter for Top Ads Insight. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_country.json)", "default": "" }, "insight_time_range": { "title": "Time range", "enum": [ "7", "30" ], "type": "string", "description": "Publication time range for Top Ads Insight. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_time_range.json)", "default": "30" }, "insight_order_field": { "title": "Sort by", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Ranking matrix used by Top Ads Insight. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_order_field.json)", "default": "1" }, "insight_creative_industry_label": { "title": "Industry label", "enum": [ "18000000000", "14000000000", "22000000000", "29000000000", "16000000000", "28000000000", "20000000000" ], "type": "string", "description": "Official industry label for Top Ads Insight - Creative Approach. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_industry.json)", "default": "18000000000" }, "insight_creative_country_code": { "title": "Country code", "enum": [ "", "US", "JP", "ID", "TH", "MY", "VN", "GB", "FR", "PH", "SA", "ZA", "KR", "ES", "MX" ], "type": "string", "description": "Official country or region filter for Top Ads Insight - Creative Approach. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_country.json)", "default": "" }, "insight_creative_time_range": { "title": "Time range", "enum": [ "7", "30" ], "type": "string", "description": "Publication time range for Top Ads Insight - Creative Approach. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_time_range.json)", "default": "30" }, "insight_creative_order_field": { "title": "Sort by", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Ranking matrix used by Top Ads Insight - Creative Approach. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_order_field.json)", "default": "1" }, "insight_selling_industry_label": { "title": "Industry label", "enum": [ "18000000000", "14000000000", "22000000000", "29000000000", "16000000000", "28000000000", "20000000000" ], "type": "string", "description": "Official industry label for Top Ads Insight - Selling Point Analysis. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_industry.json)", "default": "18000000000" }, "insight_selling_country_code": { "title": "Country code", "enum": [ "", "US", "JP", "ID", "TH", "MY", "VN", "GB", "FR", "PH", "SA", "ZA", "KR", "ES", "MX" ], "type": "string", "description": "Official country or region filter for Top Ads Insight - Selling Point Analysis. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_country.json)", "default": "" }, "insight_selling_time_range": { "title": "Time range", "enum": [ "7", "30" ], "type": "string", "description": "Publication time range for Top Ads Insight - Selling Point Analysis. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_time_range.json)", "default": "30" }, "insight_selling_order_field": { "title": "Sort by", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Ranking matrix used by Top Ads Insight - Selling Point Analysis. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_order_field.json)", "default": "1" }, "insight_top20_industry_label": { "title": "Industry label", "enum": [ "18000000000", "14000000000", "22000000000", "29000000000", "16000000000", "28000000000", "20000000000" ], "type": "string", "description": "Official industry label for Top Ads Insight - Top 20 Selling Points. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_industry.json)", "default": "18000000000" }, "insight_top20_country_code": { "title": "Country code", "enum": [ "", "US", "JP", "ID", "TH", "MY", "VN", "GB", "FR", "PH", "SA", "ZA", "KR", "ES", "MX" ], "type": "string", "description": "Official country or region filter for Top Ads Insight - Top 20 Selling Points. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_country.json)", "default": "" }, "insight_top20_time_range": { "title": "Time range", "enum": [ "7", "30" ], "type": "string", "description": "Publication time range for Top Ads Insight - Top 20 Selling Points. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_time_range.json)", "default": "30" }, "insight_top20_order_field": { "title": "Sort by", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Ranking matrix used by Top Ads Insight - Top 20 Selling Points. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_order_field.json)", "default": "1" }, "insight_top20_category": { "title": "Category", "type": "string", "description": "Use `SellingPoints[].categoryName` from `Top Ads Insight - Selling Point Analysis`; required by `Top Ads Insight - Top 20 Selling Points`." }, "insight_formula_material_industry_label": { "title": "Industry label", "enum": [ "18000000000", "14000000000", "22000000000", "29000000000", "16000000000", "28000000000", "20000000000" ], "type": "string", "description": "Official industry label for Top Ads Insight - Creative Approach Materials. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_industry.json)", "default": "18000000000" }, "insight_formula_material_country_code": { "title": "Country code", "enum": [ "", "US", "JP", "ID", "TH", "MY", "VN", "GB", "FR", "PH", "SA", "ZA", "KR", "ES", "MX" ], "type": "string", "description": "Official country or region filter for Top Ads Insight - Creative Approach Materials. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_country.json)", "default": "" }, "insight_formula_material_time_range": { "title": "Time range", "enum": [ "7", "30" ], "type": "string", "description": "Publication time range for Top Ads Insight - Creative Approach Materials. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_time_range.json)", "default": "30" }, "insight_formula_material_order_field": { "title": "Sort by", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Ranking matrix used by Top Ads Insight - Creative Approach Materials. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_order_field.json)", "default": "1" }, "insight_formula_material_formula_id": { "title": "Formula ID", "type": "string", "description": "Use `formulaList[].id` from `Top Ads Insight - Creative Approach`." }, "insight_formula_material_page": { "title": "Page", "minimum": 1, "type": "integer", "description": "Page number for Top Ads Insight - Creative Approach Materials.", "default": 1 }, "insight_formula_material_limit": { "title": "Limit", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Number of Top Ads Insight - Creative Approach Materials records per page.", "default": 20 }, "insight_selling_material_industry_label": { "title": "Industry label", "enum": [ "18000000000", "14000000000", "22000000000", "29000000000", "16000000000", "28000000000", "20000000000" ], "type": "string", "description": "Official industry label for Top Ads Insight - Selling Point Analysis Materials. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_industry.json)", "default": "18000000000" }, "insight_selling_material_country_code": { "title": "Country code", "enum": [ "", "US", "JP", "ID", "TH", "MY", "VN", "GB", "FR", "PH", "SA", "ZA", "KR", "ES", "MX" ], "type": "string", "description": "Official country or region filter for Top Ads Insight - Selling Point Analysis Materials. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_country.json)", "default": "" }, "insight_selling_material_time_range": { "title": "Time range", "enum": [ "7", "30" ], "type": "string", "description": "Publication time range for Top Ads Insight - Selling Point Analysis Materials. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_time_range.json)", "default": "30" }, "insight_selling_material_order_field": { "title": "Sort by", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Ranking matrix used by Top Ads Insight - Selling Point Analysis Materials. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_insight_order_field.json)", "default": "1" }, "insight_selling_material_selling_point": { "title": "Selling point", "type": "string", "description": "Use `SellingPoints[].sellingPointName` from `Top Ads Insight - Top 20 Selling Points`." }, "insight_selling_material_page": { "title": "Page", "minimum": 1, "type": "integer", "description": "Page number for Top Ads Insight - Selling Point Analysis Materials.", "default": 1 }, "insight_selling_material_limit": { "title": "Limit", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Number of Top Ads Insight - Selling Point Analysis Materials records per page.", "default": 20 }, "insight_detail_material_id": { "title": "Insight material ID", "type": "string", "description": "Use `itemList[].materialID` from `Top Ads Insight - Creative Approach Materials` or `Top Ads Insight - Selling Point Analysis Materials`." }, "library_industry_label": { "title": "Industry label", "enum": [ "", "20111000000", "20104000000", "25311000000", "18100000000", "16104000000", "21000000000", "23127000000", "25312000000", "13105000000", "14104000000", "23110000000", "16999000000", "13108000000", "13112000000", "12108000000", "12107000000", "12000000000", "13117000000", "11106000000", "14000000000", "25308000000", "23103000000", "23102000000", "23126000000", "23131000000", "14107000000", "18107000000", "12106000000", "12101000000", "18105000000", "24106000000", "23130000000", "13104000000", "26999000000", "11999000000", "28101000000", "12104000000", "24116000000", "23999000000", "24112000000", "30000000000", "13109000000", "15100000000", "26100000000", "18109000000", "22112000000", "14102000000", "22109000000", "23114000000", "10100000000", "25310000000", "14106000000", "22110000000", "18104000000", "23116000000", "26102000000", "19104000000", "19100000000", "19101000000", "24104000000", "24110000000", "29000000000", "25304000000", "11104000000", "18103000000", "20109000000", "13114000000", "25309000000", "27101000000", "11107000000", "21101000000", "20101000000", "17000000000", "20108000000", "11110000000", "26000000000", "10000000000", "23115000000", "23132000000", "29101000000", "15105000000", "23118000000", "24119000000", "29103000000", "12109000000", "20999000000", "23134000000", "27999000000", "23107000000", "24100000000", "23112000000", "22111000000", "24117000000", "28100000000", "12110000000", "16101000000", "18000000000", "19103000000", "23117000000", "17106000000", "14103000000", "21102000000", "29100000000", "19102000000", "25313000000", "11108000000", "26109000000", "22101000000", "11103000000", "15101000000", "23104000000", "24101000000", "16105000000", "23113000000", "13110000000", "13103000000", "30101000000", "26104000000", "11109000000", "13101000000", "14999000000", "21100000000", "22113000000", "26108000000", "23122000000", "28000000000", "15103000000", "22105000000", "22999000000", "24115000000", "21103000000", "18106000000", "24107000000", "23101000000", "13113000000", "18102000000", "24103000000", "10103000000", "20103000000", "24113000000", "20107000000", "11105000000", "19106000000", "23100000000", "17105000000", "24999000000", "25300000000", "11000000000", "20105000000", "20112000000", "18999000000", "11112000000", "21999000000", "18112000000", "13000000000", "23129000000", "24111000000", "26113000000", "25305000000", "14100000000", "19105000000", "10105000000", "12102000000", "24118000000", "20106000000", "23105000000", "22102000000", "25306000000", "12999000000", "23000000000", "27102000000", "15999000000", "15106000000", "27103000000", "25999000000", "10102000000", "24105000000", "13115000000", "29999000000", "24114000000", "20110000000", "23106000000", "16100000000", "23128000000", "16102000000", "11102000000", "11111000000", "18101000000", "15104000000", "24109000000", "10999000000", "13100000000", "15000000000", "24120000000", "24000000000", "18108000000", "23125000000", "13116000000", "30102000000", "13999000000", "14105000000", "30100000000", "11101000000", "13102000000", "18111000000", "26107000000", "26112000000", "27100000000", "25302000000", "15107000000", "26106000000", "25301000000", "21105000000", "25000000000", "23133000000", "19999000000", "20102000000", "22107000000", "20000000000", "10106000000", "24108000000", "29102000000", "26114000000", "11100000000", "13107000000", "20100000000", "12103000000", "21104000000", "27000000000", "27104000000", "22000000000", "23111000000", "16000000000", "25307000000", "14101000000", "26101000000", "26103000000", "23124000000", "23109000000", "24102000000", "12100000000", "26111000000", "22108000000", "23108000000", "23119000000", "17103000000", "22106000000", "17999000000", "19000000000", "25303000000", "23123000000", "13111000000", "15102000000", "18110000000", "26105000000", "12105000000", "10104000000", "10101000000" ], "type": "string", "description": "Official industry label for Top Ads Library. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_library_industry.json)", "default": "" }, "library_country_code": { "title": "Country code", "enum": [ "", "DZ", "AR", "AU", "AT", "AZ", "BH", "BD", "BY", "BE", "BO", "BR", "BG", "KH", "CA", "CL", "CO", "CR", "HR", "CY", "CZ", "DK", "DO", "EC", "EG", "EE", "FI", "FR", "DE", "GR", "GT", "JO", "HU", "ID", "IQ", "IE", "IL", "IT", "JP", "KZ", "KE", "KW", "LV", "LB", "MY", "MX", "MA", "NL", "NZ", "NG", "NO", "OM", "PK", "PA", "PY", "PE", "PH", "PL", "PT", "PR", "QA", "LT", "RO", "SA", "RS", "SG", "SK", "SI", "ZA", "KR", "ES", "LK", "SE", "CH", "TW", "TH", "TR", "AE", "GB", "US", "UY", "VN" ], "type": "string", "description": "Official country or region filter for Top Ads Library. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_library_country.json)", "default": "" }, "library_time_range": { "title": "Time range", "enum": [ "7", "30", "180" ], "type": "string", "description": "Publication time range for Top Ads Library. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_library_time_range.json)", "default": "30" }, "library_search_word": { "title": "Search word", "type": "string", "description": "Search by brand, product, or creative keyword." }, "library_objective": { "title": "Objective", "enum": [ "", "1", "2", "3", "4", "5", "8", "15" ], "type": "string", "description": "Campaign objective. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_library_objective.json)", "default": "" }, "library_like_cnt_filter": { "title": "Likes percentile", "enum": [ "", "1", "2", "3", "4", "5" ], "type": "string", "description": "Like count percentile filter. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_library_like_cnt_filter.json)", "default": "" }, "library_order_field": { "title": "Sort by", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Metric used to sort Top Ads Library results. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-one-scraper-public/refs/heads/main/options/top_ads_library_order_field.json)", "default": "1" }, "library_page": { "title": "Page", "minimum": 1, "type": "integer", "description": "Page number for Top Ads Library results.", "default": 1 }, "library_limit": { "title": "Limit", "minimum": 1, "maximum": 50, "type": "integer", "description": "Number of Top Ads Library records per page.", "default": 20 }, "library_material_id": { "title": "Material ID", "type": "string", "description": "Use `itemList[].materialID` from `Top Ads Library`." } } }, "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 } } } } } } } } } }