{
  "openapi": "3.0.1",
  "info": {
    "title": "微信视频号 / WeChat Channels API - 热搜、搜索、评论、用户数据",
    "description": "社媒数据助手 SocialDataX 提供的只读微信视频号 / WeChat Channels data API，支持热搜 / hot list、视频搜索 / video search、视频详情 / video details、评论 / comments、评论回复 / comment replies、用户资料 / creator profiles 和用户视频列表 / creator videos。",
    "version": "0.1",
    "x-build-id": "o9fjoKw3M2DgGazZR"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/socialdatax~socialdatax-wechat-data-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-socialdatax-socialdatax-wechat-data-api",
        "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/socialdatax~socialdatax-wechat-data-api/runs": {
      "post": {
        "operationId": "runs-sync-socialdatax-socialdatax-wechat-data-api",
        "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/socialdatax~socialdatax-wechat-data-api/run-sync": {
      "post": {
        "operationId": "run-sync-socialdatax-socialdatax-wechat-data-api",
        "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": [
          "operation"
        ],
        "properties": {
          "operation": {
            "title": "操作 / Operation",
            "enum": [
              "search_hot_list",
              "search_videos",
              "get_video_detail",
              "get_user_info",
              "list_user_videos",
              "get_video_comments",
              "get_video_comment_replies"
            ],
            "type": "string",
            "description": "先选择要调用的微信视频号 / WeChat Channels 数据能力，然后只填写该 operation 需要的字段；无关字段会被忽略。持续使用需要 Apify paid plan；free plan 用户有 5 次 SocialDataX API request 试用额度。Choose the operation first, then fill only the fields used by that operation.",
            "default": "search_videos"
          },
          "keyword": {
            "title": "关键词 / Keyword",
            "type": "string",
            "description": "仅 operation=search_videos 时必填；其它 operation 可留空。Search keyword for WeChat Channels video search.",
            "default": "露营"
          },
          "sort_type": {
            "title": "搜索排序 / Search sort",
            "enum": [
              "all",
              "time_descending",
              "collect_count_descending"
            ],
            "type": "string",
            "description": "仅 operation=search_videos 时使用。all=综合，time_descending=最新优先，collect_count_descending=收藏数优先。",
            "default": "all"
          },
          "duration_range": {
            "title": "视频时长 / Duration",
            "enum": [
              "all",
              "under_5_min",
              "between_5_and_20_min",
              "over_20_min"
            ],
            "type": "string",
            "description": "仅 operation=search_videos 时使用。all=全部，under_5_min=5 分钟以下，between_5_and_20_min=5-20 分钟，over_20_min=20 分钟以上。",
            "default": "all"
          },
          "url": {
            "title": "视频链接 / Video URL",
            "type": "string",
            "description": "operation=get_video_detail、get_video_comments、list_user_videos 时可使用。推荐直接粘贴微信视频号视频链接或分享文案。详情接口不要同时传 url 和 encrypted_object_id；评论接口不要同时传 url 和 object_id + object_nonce_id。"
          },
          "encrypted_object_id": {
            "title": "加密视频 ID / Encrypted object ID",
            "type": "string",
            "description": "operation=get_video_detail 时可使用；从 search_videos Dataset 行里的 encrypted_object_id 复制。不要和 url 同时填写。"
          },
          "object_id": {
            "title": "视频 object_id / Object ID",
            "type": "string",
            "description": "operation=get_video_comments、get_video_comment_replies 时使用；与同一条视频的 object_nonce_id 一起从 get_video_detail 或评论 Dataset 行中复制。评论回复不支持 url 或 encrypted_object_id。"
          },
          "object_nonce_id": {
            "title": "视频 object_nonce_id / Object nonce ID",
            "type": "string",
            "description": "operation=get_video_comments、get_video_comment_replies 时使用；必须和同一条视频的 object_id 配对原样传入。"
          },
          "comment_id": {
            "title": "一级评论 ID / Comment ID",
            "type": "string",
            "description": "仅 operation=get_video_comment_replies 时必填。先运行 get_video_comments，在 Dataset 里找到 reply_count > 0 的一级评论行，复制该行的 comment_id；不要填评论内容、昵称或回复项 ID。"
          },
          "user_id": {
            "title": "视频号用户 ID / User ID",
            "type": "string",
            "description": "operation=get_user_info、list_user_videos 时使用。只支持以 @finder 结尾的微信视频号用户 ID；可从视频详情、评论、评论回复或用户视频列表 Dataset 行里的 author_user_id / user_id 复制。不要填昵称、主页名称或 @stranger ID。"
          },
          "page_token": {
            "title": "分页令牌 / Page token",
            "type": "string",
            "description": "搜索、评论、评论回复、用户视频列表继续翻页时传入上一页返回的完整 next_page_token；第一页留空。auto_paginate=true 时通常不用手动填写。"
          },
          "max_items": {
            "title": "最大结果数 / Max items",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "最多写入多少条 Dataset item。对搜索、评论、评论回复、用户视频列表用于限制自动翻页结果；对热搜用于限制本次导出的热搜条目数。较大的值可能触发多次 SocialDataX API request。",
            "default": 50
          },
          "auto_paginate": {
            "title": "自动翻页 / Auto paginate",
            "type": "boolean",
            "description": "开启后 Actor 会按 next_page_token 继续请求，直到达到 max_items 或没有下一页。关闭时只请求当前 page_token。每翻一页计 1 次 SocialDataX API request。When enabled, each page request counts as one SocialDataX API request.",
            "default": true
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}