{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Affiliate Products Scraper - Creator Showcase", "description": "Scrape every TikTok Shop affiliate product a creator promotes in their showcase: price, discount, units sold, rating, reviews, shop and product links.", "version": "1.0", "x-build-id": "fwvdurcTThuTllexe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/seemuapps~tiktok-shop-creator-showcase-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-seemuapps-tiktok-shop-creator-showcase-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/seemuapps~tiktok-shop-creator-showcase-scraper/runs": { "post": { "operationId": "runs-sync-seemuapps-tiktok-shop-creator-showcase-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/seemuapps~tiktok-shop-creator-showcase-scraper/run-sync": { "post": { "operationId": "run-sync-seemuapps-tiktok-shop-creator-showcase-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": [ "usernames" ], "properties": { "usernames": { "title": "TikTok creators", "type": "array", "description": "TikTok usernames (with or without @) or profile URLs such as https://www.tiktok.com/@mrtiktokreviews. Every product in each creator's public TikTok Shop showcase is returned, one row per product.", "items": { "type": "string" } }, "maxProductsPerCreator": { "title": "Max products per creator", "minimum": 0, "maximum": 2000, "type": "integer", "description": "Maximum showcase products to return for each creator. Set 0 for the full showcase (up to 2000 per creator).", "default": 100 }, "maxItems": { "title": "Max products in total", "minimum": 0, "type": "integer", "description": "Overall cap on rows for the whole run across all creators. 0 means no overall cap. If the run stops at this cap, continue later with Page ID.", "default": 0 }, "includeProductDetails": { "title": "Include shop name, category and all images", "type": "boolean", "description": "Also opens each product page to add the shop name, product category, all product images, price range, free-shipping flag, shop rating, followers and units sold, and the number of creator videos promoting the product. Slower, and each enriched row is billed as a product-details result.", "default": false }, "includeCreatorProfile": { "title": "Include creator profile stats", "type": "boolean", "description": "Adds the creator's display name, follower count, total likes, video count, verified badge and bio link to every row. Looked up once per creator, at no extra charge per row.", "default": false }, "region": { "title": "Shop region", "enum": [ "US", "GB", "DE", "FR", "IT", "ES", "IE", "MX", "BR", "JP", "ID", "MY", "PH", "SG", "TH", "VN" ], "type": "string", "description": "TikTok Shop marketplace to read the showcase from. The US has full coverage; other regions are often incomplete or empty.", "default": "US" }, "pageId": { "title": "Page ID (pagination)", "type": "string", "description": "Paste NEXT_PAGE_ID from the previous run's Key-value store to continue where it stopped (after a timeout or the Max products in total cap). Keep the same creator list. Leave empty to start from the beginning." } } }, "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 } } } } } } } } } }