{
  "openapi": "3.0.1",
  "info": {
    "title": "WeChat Channels Scraper 视频号 — Videos, Creators, Comments & MP4",
    "description": "WeChat Channels (视频号) scraper: search videos by keyword, list a creator's latest videos, get likes, shares and comments, creator followers and verified company, and download decrypted MP4 files. Paste share links, sph IDs or usernames. Only-new monitoring. No login.",
    "version": "0.1",
    "x-build-id": "HmyU7CD2EEnQhfTHl"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/memo23~wechat-channels-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-memo23-wechat-channels-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/memo23~wechat-channels-scraper/runs": {
      "post": {
        "operationId": "runs-sync-memo23-wechat-channels-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/memo23~wechat-channels-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-memo23-wechat-channels-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": "Search WeChat Channels videos. About 10 videos per page. Example: `美食`.",
            "items": {
              "type": "string"
            }
          },
          "creators": {
            "title": "Creators",
            "type": "array",
            "description": "Returns each creator's latest 15 videos. Give a finder username (`v2_…@finder`), a public Channels ID (`sph…`), or a share link to any of their videos (`https://weixin.qq.com/sph/…`).",
            "items": {
              "type": "string"
            }
          },
          "includeLatestVideos": {
            "title": "Creator's latest videos",
            "type": "boolean",
            "description": "Return each creator's latest 15 videos. Turn off when you only want collections or in-creator search results. Default: on.",
            "default": true
          },
          "includeCollections": {
            "title": "Include creator collections (合集)",
            "type": "boolean",
            "description": "Also list each creator's collections and return their videos, about 20 per page with full stats and media. This reaches past the latest-15 limit: a news account's collection can hold hundreds of videos. Pages per collection follow Max search pages. Default: off.",
            "default": false
          },
          "includeLiveReplays": {
            "title": "Include live-stream replays",
            "type": "boolean",
            "description": "Also return each creator's live-stream replays as video rows, with likes, shares, comments and a media link (downloadable like any video). Pages follow Max pages. Default: off.",
            "default": false
          },
          "creatorSearchKeywords": {
            "title": "Search inside each creator",
            "type": "array",
            "description": "Keywords searched within each creator's own videos, about 20 results per page. Finds older videos the latest-15 list does not show. Example: `新闻`.",
            "items": {
              "type": "string"
            }
          },
          "videoUrls": {
            "title": "Video links",
            "type": "array",
            "description": "Share links (`https://weixin.qq.com/sph/A08McxiQhh`), numeric object ids, or `export/…` ids. Each returns the full video record.",
            "items": {
              "type": "string"
            }
          },
          "sort": {
            "title": "Sort",
            "enum": [
              "default",
              "latest",
              "hot"
            ],
            "type": "string",
            "description": "Order of search results. Default: relevance.",
            "default": "default"
          },
          "publishTime": {
            "title": "Published within",
            "enum": [
              "all",
              "day",
              "week",
              "half_year"
            ],
            "type": "string",
            "description": "Limit search results to a time window. Default: any time.",
            "default": "all"
          },
          "duration": {
            "title": "Video length",
            "enum": [
              "all",
              "short",
              "medium",
              "long"
            ],
            "type": "string",
            "description": "Limit search results by length. Default: any.",
            "default": "all"
          },
          "maxPages": {
            "title": "Max pages",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Pages per search keyword (~10 videos), per in-creator keyword (~20) and per collection (~20). Default 3.",
            "default": 3
          },
          "includeVideoDetails": {
            "title": "Full details for search results",
            "type": "boolean",
            "description": "Search results carry title, creator name, likes and duration. Turn this on to look up each one in full: likes, favorites, shares, comment count, location, creator username and media link. Billed as `video-detail` instead of `video`. Turned on automatically when you ask for comments or downloads on search results. Default: off.",
            "default": false
          },
          "includeShareLinks": {
            "title": "Add share links",
            "type": "boolean",
            "description": "Add a clickable `shareUrl` (`https://weixin.qq.com/sph/…`) to each video that has an object id (all except light search results). Billed as `share-link` per link. Default: off.",
            "default": false
          },
          "includeCreatorProfile": {
            "title": "Creator profile",
            "type": "boolean",
            "description": "For each entry in Creators, add a `creator` row with followers, video count, likes, region, bio, live hours and linked Official Accounts. Billed as `creator-profile`. Default: off.",
            "default": false
          },
          "includeVerification": {
            "title": "Creator verification",
            "type": "boolean",
            "description": "For each entry in Creators, add the verified company, entity type, news license number, verification date, Channels ID and IP location. Billed as `creator-verification`. Default: off.",
            "default": false
          },
          "includeComments": {
            "title": "Comments",
            "type": "boolean",
            "description": "Return each video's comments as rows with `type: comment`: author, text, likes, reply count, time. Default: off.",
            "default": false
          },
          "maxCommentsPerVideo": {
            "title": "Max comments per video",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "Comments come 25 per page. Default 25.",
            "default": 25
          },
          "includeReplies": {
            "title": "Replies to comments",
            "type": "boolean",
            "description": "Also return replies (`type: reply`) for comments with 5 or more replies. Needs Comments. Default: off.",
            "default": false
          },
          "maxRepliesPerComment": {
            "title": "Max replies per comment",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Default 20.",
            "default": 20
          },
          "downloadVideos": {
            "title": "Download MP4 files",
            "type": "boolean",
            "description": "Download each video, decrypt it and save a playable MP4 to the run's key-value store. The row gets `videoFileUrl`. Billed as `video-download` per saved file. Default: off.",
            "default": false
          },
          "maxVideoSizeMb": {
            "title": "Max video size (MB)",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Skip files larger than this. A 1-minute video is about 25 MB; live-stream replays are often 1-3 GB and are skipped at the default. Files are held in memory while being decrypted, so raise the run's memory to at least twice this value. Default 200, maximum 1000.",
            "default": 200
          },
          "maxItems": {
            "title": "Maximum videos",
            "minimum": 1,
            "type": "integer",
            "description": "Cap on video rows. Comments, replies and creator rows are capped separately. Default 50. Free-tier runs are capped at 100.",
            "default": 50
          },
          "monitorMode": {
            "title": "Monitoring mode (only-new videos)",
            "type": "boolean",
            "description": "Skip videos already delivered to you; they are not billed and no data is bought for them. First run builds the baseline. Default: false.",
            "default": false
          },
          "monitorStateName": {
            "title": "Monitor state name",
            "type": "string",
            "description": "Separate seen-lists for several schedules. Example: `food-creators`."
          },
          "resetMonitoringState": {
            "title": "Reset monitoring state",
            "type": "boolean",
            "description": "Clear the seen-list at the start of this run. Default: false.",
            "default": false
          },
          "emitBaseline": {
            "title": "Emit baseline on first monitoring run",
            "type": "boolean",
            "description": "ON (default): first monitoring run returns current videos. OFF: first run seeds silently.",
            "default": true
          },
          "includeUnchanged": {
            "title": "Include unchanged (monitoring)",
            "type": "boolean",
            "description": "Also re-emit already-seen videos, tagged `changeType`. Billed. Default: false.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}