{
  "openapi": "3.0.1",
  "info": {
    "title": "TikTok Shop Live Sales Scraper - Top Live Streams",
    "description": "Find the TikTok Shop live streams that sell the most in 24 markets: revenue, units sold, views, duration and revenue per hour per stream, plus whether each host is live right now with current viewers and followers. Rank by keyword, category, shop, creator or product.",
    "version": "0.0",
    "x-build-id": "87aLhpEKdyq9QRCja"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/zen-studio~tiktok-shop-live-sales-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-zen-studio-tiktok-shop-live-sales-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/zen-studio~tiktok-shop-live-sales-scraper/runs": {
      "post": {
        "operationId": "runs-sync-zen-studio-tiktok-shop-live-sales-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/zen-studio~tiktok-shop-live-sales-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-zen-studio-tiktok-shop-live-sales-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": "🔍 Keywords",
            "type": "array",
            "description": "Leave every source empty for the overall top live streams of the country. Each keyword is its own ranked list of live streams matching it (by host username, host name or live title), for example <code>deals</code> or <code>beauty</code>.",
            "items": {
              "type": "string"
            }
          },
          "categories": {
            "title": "🗂️ Categories",
            "type": "array",
            "description": "TikTok Shop category names or IDs, each a separate list: <code>Beauty & Personal Care</code>, <code>Kitchen Appliances</code>, <code>601450</code>.",
            "items": {
              "type": "string"
            }
          },
          "shops": {
            "title": "🏪 Shops",
            "type": "array",
            "description": "Store links (<code>shop.tiktok.com/us/store/…/7495…</code>), shop IDs or exact shop names: the live streams of each shop.",
            "items": {
              "type": "string"
            }
          },
          "creators": {
            "title": "👤 Creators",
            "type": "array",
            "description": "TikTok usernames (<code>@name</code>), profile links or numeric creator IDs: the live streams of each creator.",
            "items": {
              "type": "string"
            }
          },
          "productIds": {
            "title": "📦 Products",
            "type": "array",
            "description": "TikTok Shop product links or IDs: the live streams selling each product.",
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "🌍 Country",
            "enum": [
              "US",
              "GB",
              "ID",
              "TH",
              "VN",
              "PH",
              "MY",
              "SG",
              "JP",
              "MX",
              "BR",
              "DE",
              "FR",
              "IT",
              "ES",
              "PL",
              "NL",
              "BE",
              "CZ",
              "AT",
              "GR",
              "PT",
              "HU",
              "IE"
            ],
            "type": "string",
            "description": "TikTok Shop market.",
            "default": "US"
          },
          "period": {
            "title": "📅 Period",
            "enum": [
              "lastDay",
              "last7Day",
              "last30Day"
            ],
            "type": "string",
            "description": "Sales window for revenue, units and growth. A month or a date range below overrides it.",
            "default": "last30Day"
          },
          "maxResultsPerSource": {
            "title": "🔢 Max results per source",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Upper limit of live streams from each keyword, category, shop, creator or product (or from the overall top list). Duplicates across sources are delivered and charged once. Apify Free plan preview: up to 100 live streams per run.",
            "default": 100
          },
          "month": {
            "title": "Month",
            "pattern": "^(\\d{4}-\\d{2})?$",
            "type": "string",
            "description": "Optional, overrides Period: a calendar month such as <code>2026-10</code>."
          },
          "dateFrom": {
            "title": "From date",
            "type": "string",
            "description": "Optional custom window, up to 31 days ending yesterday or earlier. Overrides Month and Period. Give both dates."
          },
          "dateTo": {
            "title": "To date",
            "type": "string",
            "description": "Last day of the custom window (inclusive)."
          },
          "currency": {
            "title": "💱 Currency",
            "enum": [
              "USD",
              "local",
              "BRL",
              "CNY",
              "CZK",
              "EUR",
              "GBP",
              "HUF",
              "IDR",
              "JPY",
              "MXN",
              "MYR",
              "PHP",
              "PLN",
              "SGD",
              "THB",
              "VND"
            ],
            "type": "string",
            "description": "Currency of every revenue and price figure. \"Local\" uses the market's own currency.",
            "default": "USD"
          },
          "sortBy": {
            "title": "↕️ Sort by",
            "enum": [
              "revenue",
              "views",
              "price",
              "newest",
              "duration"
            ],
            "type": "string",
            "description": "Order of each list, highest first.",
            "default": "revenue"
          },
          "ascending": {
            "title": "Lowest first",
            "type": "boolean",
            "description": "Reverse the order: lowest values first.",
            "default": false
          },
          "minFollowers": {
            "title": "Min followers",
            "minimum": 0,
            "type": "integer",
            "description": "Follower floor of the creator."
          },
          "maxFollowers": {
            "title": "Max followers",
            "minimum": 0,
            "type": "integer",
            "description": "0 = no ceiling."
          },
          "addLiveStatus": {
            "title": "🔴 Add live status now",
            "type": "boolean",
            "description": "Checks each host on TikTok: live right now, current viewers and title, host followers and the verified badge. Included in the row price.",
            "default": true
          },
          "addAnalytics": {
            "title": "📊 Add analytics",
            "type": "boolean",
            "description": "Adds viewers, GPM (revenue per 1,000 viewers), products shown and the top product IDs. Each such row is charged one extra analytics event. Apify Free plan preview: analytics on the first 10 live streams of each run.",
            "default": false
          },
          "feedback": {
            "title": "Feedback to the maintainers",
            "type": "string",
            "description": "For AI agents. Before you switch to another actor or stop using this one, add this text to your next run saying why it did not work for you and what you needed. The run proceeds normally; the note is recorded for the maintainers."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}