{
  "openapi": "3.0.1",
  "info": {
    "title": "Kwai & Kuaishou Scraper [$2.50/1K💰] | Video Data",
    "description": "Scrape public Kwai and Kuaishou videos, creator profiles, hashtags, captions, engagement metrics and hot-board topics. Search by keyword, profile or video URL. $2.50 per 1,000 items.",
    "version": "1.0",
    "x-build-id": "reZsdcaltbNlP8i2K"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/ahmed_jasarevic~kwai-kuaishou-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-ahmed_jasarevic-kwai-kuaishou-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/ahmed_jasarevic~kwai-kuaishou-scraper/runs": {
      "post": {
        "operationId": "runs-sync-ahmed_jasarevic-kwai-kuaishou-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/ahmed_jasarevic~kwai-kuaishou-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-ahmed_jasarevic-kwai-kuaishou-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": {
          "platform": {
            "title": "Platform",
            "enum": [
              "kwai",
              "kuaishou"
            ],
            "type": "string",
            "description": "Choose Kwai (kwai.com) or Kuaishou (kuaishou.com). Ignored for items in Mixed start URLs. Kuaishou supports the hot board and individual video details.",
            "default": "kwai"
          },
          "startUrls": {
            "title": "Mixed start URLs or IDs (optional)",
            "type": "array",
            "description": "Optional. Mix Kwai video/profile URLs and Kuaishou video URLs/share IDs in one run. When filled, platform and mode are inferred per item and the mode-specific lists below are ignored. Kwai profiles must be a profile URL or start with @.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "mode": {
            "title": "What to scrape",
            "type": "string",
            "description": "Kwai: trending, search, creator-search, hashtag, profile or video. Kuaishou: trending (hot board) or video (individual public video details). Ignored when Mixed start URLs is filled. Invalid values return a warning and an empty successful run.",
            "default": "trending"
          },
          "keywords": {
            "title": "Keywords",
            "type": "array",
            "description": "Kwai only. Keywords used when mode is search. Each keyword is processed separately.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "creatorKeywords": {
            "title": "Creator discovery keywords",
            "type": "array",
            "description": "Kwai only. Used when mode is creator-search. Finds public creators behind matching videos and fetches their profile details when Include profile info is enabled.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "hashtags": {
            "title": "Hashtags",
            "type": "array",
            "description": "Kwai only. Hashtags used when mode is hashtag. You can enter them with or without the # sign.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "profiles": {
            "title": "Profiles",
            "type": "array",
            "description": "Kwai only. Creator handles or profile URLs used when mode is profile. Examples: @cineverso678, https://www.kwai.com/@cineverso678",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "videoUrls": {
            "title": "Video URLs or IDs",
            "type": "array",
            "description": "Video URLs or IDs used when mode is video. Kwai examples: https://www.kwai.com/@user/video/123, https://www.kwai.com/video/123, plain numeric IDs. Kuaishou examples: https://www.kuaishou.com/short-video/3xih66uh55zurkm, https://m.kuaishou.com/fw/photo/3xih66uh55zurkm, plain share IDs.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Hard cap on the total number of dataset items. A profile, hot-board topic or expanded hot-board video counts as one item.",
            "default": 100
          },
          "maxItemsPerSource": {
            "title": "Max items per source",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Cap for each keyword, hashtag, profile, creator keyword or video input. Kuaishou hot board returns up to 50 topics.",
            "default": 100
          },
          "maxCreatorsPerKeyword": {
            "title": "Max creators per keyword",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Kwai creator discovery only. Upper bound on creator profile rows produced by one keyword.",
            "default": 40
          },
          "maxPaginationPages": {
            "title": "Max pagination pages",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Kwai only. Maximum extra API pages fetched for each source after the initial page. Creator discovery uses one search page. Kuaishou returns its hot board in one request.",
            "default": 20
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Number of sources processed in parallel. Keep this low to avoid rate limits.",
            "default": 4
          },
          "requestDelayMillis": {
            "title": "Delay between API requests (ms)",
            "minimum": 0,
            "maximum": 5000,
            "type": "integer",
            "description": "Polite delay between internal API pagination calls.",
            "default": 250
          },
          "includeVideoDownloadUrl": {
            "title": "Include direct video URL",
            "type": "boolean",
            "description": "Include the direct MP4 URL in each video item when available.",
            "default": true
          },
          "includeProfileInfo": {
            "title": "Include profile info",
            "type": "boolean",
            "description": "Kwai only. For profile mode, add one profile item before the videos. For creator discovery, fetch full public profile stats instead of lightweight creator rows.",
            "default": true
          },
          "includeRelatedVideos": {
            "title": "Include related videos",
            "type": "boolean",
            "description": "Kwai only. When scraping a video, also add the related videos shown on the page.",
            "default": false
          },
          "includeHotBoardVideos": {
            "title": "Expand Kuaishou hot-board videos",
            "type": "boolean",
            "description": "Kuaishou only. Also fetch full public video details for videos linked to hot-board topics. Expanded videos count toward Max items. Every dataset item has a standard per-result charge; each expanded hot-board video triggers an additional pay-per-event charge.",
            "default": false
          },
          "maxHotBoardVideos": {
            "title": "Max expanded hot-board videos",
            "minimum": 0,
            "maximum": 500,
            "type": "integer",
            "description": "Kuaishou only. Upper bound on hot-board videos fetched across all topics. Set 0 or disable Expand Kuaishou hot-board videos to skip.",
            "default": 60
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional. For Kwai, a Brazil proxy gives the most representative feed. Kuaishou video details work without a proxy; use a China or residential proxy if the hot board is rate-limited from your region.",
            "default": {
              "useApifyProxy": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}