{ "openapi": "3.0.1", "info": { "title": "小红书数据 API | SocialDataX Xiaohongshu XHS RedNote", "description": "社媒数据助手 SocialDataX 提供的只读小红书 / Xiaohongshu / XHS / RedNote data API，支持笔记搜索 / note search、笔记详情 / note details、评论 / comments、评论回复 / comment replies、博主信息 / creator profiles 和博主笔记列表 / creator notes。", "version": "0.1", "x-build-id": "8q0PiDxUxfwGbUSWo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/socialdatax~socialdatax-xhs-data-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-socialdatax-socialdatax-xhs-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-xhs-data-api/runs": { "post": { "operationId": "runs-sync-socialdatax-socialdatax-xhs-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-xhs-data-api/run-sync": { "post": { "operationId": "run-sync-socialdatax-socialdatax-xhs-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_notes", "search_hot_list", "get_note_detail", "get_user_info", "list_user_notes", "get_note_comments", "get_note_sub_comments" ], "type": "string", "description": "选择要调用的小红书 / Xiaohongshu / XHS / RedNote 数据能力。持续使用需要 Apify paid plan；free plan 用户有 5 次 SocialDataX API request 试用额度。Choose the data operation. Ongoing use requires an Apify paid plan; free-plan users get a 5-request trial.", "default": "search_notes" }, "keyword": { "title": "关键词 / Keyword", "type": "string", "description": "operation=search_notes 时必填。", "default": "露营" }, "page": { "title": "搜索页码 / Search page", "minimum": 1, "type": "integer", "description": "operation=search_notes 时可选，从 1 开始。", "default": 1 }, "sort_type": { "title": "排序 / Sort type", "enum": [ "general", "time_descending", "like_count_descending", "comment_count_descending", "collect_count_descending" ], "type": "string", "description": "operation=search_notes 时可选。", "default": "general" }, "note_type": { "title": "笔记类型 / Note type", "enum": [ "all", "image", "video" ], "type": "string", "description": "operation=search_notes 时可选。", "default": "all" }, "publish_time_range": { "title": "发布时间 / Publish time", "enum": [ "all", "day", "week", "half_year" ], "type": "string", "description": "operation=search_notes 时可选。", "default": "all" }, "note_id": { "title": "笔记 ID / Note ID", "type": "string", "description": "operation=get_note_detail、get_note_comments、get_note_sub_comments 时使用；详情接口可与 note_url 二选一。" }, "note_url": { "title": "笔记链接 / Note URL", "type": "string", "description": "operation=get_note_detail 时可与 note_id 二选一，支持小红书笔记链接、短链接或分享文案。" }, "user_id": { "title": "用户 ID / User ID", "type": "string", "description": "operation=get_user_info、list_user_notes 时可与 profile_url 二选一。" }, "profile_url": { "title": "主页链接 / Profile URL", "type": "string", "description": "operation=get_user_info、list_user_notes 时可与 user_id 二选一，支持主页链接、短链接或分享文案。" }, "comment_id": { "title": "一级评论 ID / Comment ID", "type": "string", "description": "operation=get_note_sub_comments 时必填。" }, "page_token": { "title": "分页令牌 / Page token", "type": "string", "description": "评论、评论回复、博主笔记列表继续翻页时传入上一页返回的 next_page_token；第一页留空。" }, "max_items": { "title": "最大结果数 / Max items", "minimum": 1, "maximum": 500, "type": "integer", "description": "最多写入多少条 Dataset item。对搜索、评论、评论回复、博主笔记列表用于限制自动翻页结果；对搜索热榜用于限制本次导出的热榜条目数。", "default": 50 }, "auto_paginate": { "title": "自动翻页 / Auto paginate", "type": "boolean", "description": "开启后 Actor 会按 next_page 或 next_page_token 继续请求，直到达到 max_items 或没有下一页。关闭时只请求当前 page/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 } } } } } } } } } }