{
  "openapi": "3.0.1",
  "info": {
    "title": "TikTok Shop Scraper AIO | Search, Sold Velocity & Shop Rankings",
    "description": "All-in-one TikTok Shop (US) scraper: keyword search with sold count, price, rating and the bound TikTok video; full product pages with SKUs, stock and seller compliance; plus the shops behind the results and every sort/category filter TikTok offers. Sort by best sellers or price. No API key.",
    "version": "0.0",
    "x-build-id": "Qg8E7sEZaXdw7PF9k"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tactful_anvil~tiktok-shop-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tactful_anvil-tiktok-shop-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/tactful_anvil~tiktok-shop-scraper/runs": {
      "post": {
        "operationId": "runs-sync-tactful_anvil-tiktok-shop-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/tactful_anvil~tiktok-shop-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-tactful_anvil-tiktok-shop-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": {
          "keywords": {
            "title": "Search keywords",
            "type": "array",
            "description": "One TikTok Shop (US) search per line, e.g. \"air fryer\", \"led strip lights\", \"protein powder\".",
            "default": [
              "air fryer"
            ],
            "items": {
              "type": "string"
            }
          },
          "maxResultsPerKeyword": {
            "title": "Max products per keyword",
            "minimum": 1,
            "maximum": 600,
            "type": "integer",
            "description": "Products to collect per keyword (30 per page, max 600).",
            "default": 60
          },
          "productUrls": {
            "title": "Product URLs or IDs (full details)",
            "type": "array",
            "description": "shop.tiktok.com/us/pdp/…/<id>, tiktok.com/view/product/<id> or the 19-digit product id. Each returns a product-detail row (SKUs, stock, description, delivery, seller compliance).",
            "items": {
              "type": "string"
            }
          },
          "enrichDetails": {
            "title": "Fetch full details for every search result",
            "type": "boolean",
            "description": "Adds a product-detail row for each product found by keyword — charged per detail.",
            "default": false
          },
          "includeMarketSummary": {
            "title": "Add free market-summary row per keyword",
            "type": "boolean",
            "description": "Median/min/max price, avg rating, total & avg sold count, estimated GMV, video share, free-shipping share, top shops. Never charged.",
            "default": true
          },
          "region": {
            "title": "TikTok Shop region",
            "enum": [
              "us",
              "uk",
              "id",
              "my",
              "th",
              "vn",
              "ph",
              "sg"
            ],
            "type": "string",
            "description": "Which TikTok Shop storefront to read. VERIFIED 11 Sep 2026: from Apify's default (US) infrastructure only `us` returns products — uk/id answer with an empty page, my/th/vn/ph/sg redirect away. For any non-US region you must supply `proxyConfiguration` with a proxy located in that country; otherwise the run ends with 0 rows and a clear status message.",
            "default": "us"
          },
          "__probe": {
            "title": "(internal) endpoint probe",
            "type": "boolean",
            "description": "Maintenance only: maps which TikTok Shop endpoints and regions answer from this run's IP. Produces free diagnostic rows and nothing else.",
            "default": false
          },
          "sortBy": {
            "title": "Sort search results",
            "enum": [
              "relevance",
              "best_sellers",
              "price_asc",
              "price_desc",
              "newest"
            ],
            "type": "string",
            "description": "Order the search results. The tokens come from TikTok Shop's own filter panel. Leave on Relevance to keep the exact behaviour of earlier runs. NOTE (11 Sep 2026): TikTok's search API currently ignores server-side sort tokens, so the chosen order is applied to the fetched result set (up to maxResultsPerKeyword). Raise maxResultsPerKeyword to sort over a larger pool.",
            "default": "relevance"
          },
          "includeShops": {
            "title": "Also return the shops behind the results",
            "type": "boolean",
            "description": "Adds free `shop` rows (seller id, shop name, logo, verified badge, shop URL) taken from the same page the products come from — no extra requests and no extra charge.",
            "default": false
          },
          "includeFilters": {
            "title": "Also return the available filters",
            "type": "boolean",
            "description": "Adds one free `search-filters` row per keyword listing every sort option, category, colour, price band and rating filter TikTok offers for that search, with the exact tokens. Free.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy (for non-US regions)",
            "type": "object",
            "description": "Optional. Required in practice for any region other than `us`: TikTok Shop serves each storefront only to IPs in that country. Point this at your own residential proxy in the target country (Apify datacenter proxies are US-based)."
          },
          "trackTrends": {
            "title": "Track trends between runs (sold velocity, price moves, rank moves, new listings)",
            "type": "boolean",
            "description": "Compares every product with the previous run stored in your account (key-value store <code>tiktok-shop-trends</code>) and adds <code>soldCountChange</code>, <code>soldPerDay</code>, <code>priceChange</code>, <code>priceChangePct</code>, <code>rankChange</code>, <code>isNewListing</code>, <code>hoursSinceLastRun</code>, <code>trendSignal</code> (hot / selling / flat / price-drop / price-up). First run only saves the baseline. No extra charge — schedule the Actor (e.g. daily) and the deltas are real, observed numbers.",
            "default": false
          },
          "onlyChanges": {
            "title": "Only push products that changed (watch-list mode)",
            "type": "boolean",
            "description": "With <b>trackTrends</b>: rows whose sold count, price and rank are unchanged since the last run are skipped and <b>not charged</b>. New listings and the first (baseline) run always come through. Ideal for a scheduled watch-list of <code>productUrls</code> or a few keywords.",
            "default": false
          },
          "includeShopLeaderboard": {
            "title": "Shop leaderboard per keyword (free)",
            "type": "boolean",
            "description": "Adds up to 10 free <code>shop-leaderboard</code> rows per keyword: which shops dominate the search — listings, share of listings, total sold, share of sold, median price, average rating, best position. Built from the products already fetched, no extra requests.",
            "default": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}