{ "openapi": "3.0.1", "info": { "title": "Rednote Scraper", "description": "集小红书数据采集、用户交互、内容发布于一体, 秒级响应的 All-In-One 自动化工具", "version": "0.0", "x-build-id": "Ym8zJIfFi3fovd3Cr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/doliz~rednote-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-doliz-rednote-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/doliz~rednote-scraper/runs": { "post": { "operationId": "runs-sync-doliz-rednote-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/doliz~rednote-scraper/run-sync": { "post": { "operationId": "run-sync-doliz-rednote-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", "required": [ "target", "cookies" ], "properties": { "target": { "title": "Target", "enum": [ "me", "self_info", "keyword_trending", "keyword_recommend", "mentions", "likes", "follows", "homefeed_category", "homefeed", "search_filter", "search_note", "search_user", "user_info", "user_note", "user_like_note", "user_collect_note", "note_info", "get_comment", "get_sub_comment", "like_note", "dislike_note", "collect_note", "uncollect_note", "post_comment", "delete_comment", "like_comment", "dislike_comment", "search_topic", "create_topic", "search_location", "publish_note" ], "type": "string", "description": "选择数据源。您的选择决定使用下面的哪些设置", "default": "me" }, "cookies": { "title": "Cookies", "type": "string", "description": "cookies. 获取方法: ![](https://github.com/lofe-w/rednote-scraper-public/raw/main/imgs/get_cookie.png)", "default": "Your cookies" }, "keyword_recommend_keyword": { "title": "关键词", "type": "string", "description": "", "default": "榴莲" }, "mentions_num": { "title": "获取数量", "type": "integer", "description": "", "default": 20 }, "mentions_cursor": { "title": "分页游标", "type": "string", "description": "从前一页的结果中获取, 第一页为空", "default": "" }, "likes_num": { "title": "获取数量", "type": "integer", "description": "", "default": 20 }, "likes_cursor": { "title": "分页游标", "type": "string", "description": "从前一页的结果中获取, 第一页为空", "default": "" }, "follows_num": { "title": "获取数量", "type": "integer", "description": "", "default": 20 }, "follows_cursor": { "title": "分页游标", "type": "string", "description": "从前一页的结果中获取, 第一页为空", "default": "" }, "homefeed_cursor_score": { "title": "分页游标", "type": "string", "description": "从前一页的结果中获取, 第一页时为空", "default": "" }, "homefeed_num": { "title": "笔记数量", "type": "integer", "description": "", "default": 50 }, "homefeed_refresh_type": { "title": "刷新类型", "enum": [ "1", "3" ], "type": "string", "description": "1: 初始加载/下拉刷新; 3: 上滑加载更多", "default": "1" }, "homefeed_note_index": { "title": "笔记总量", "type": "integer", "description": "笔记总量(累计). 第一页时等于 `笔记数量`", "default": 43 }, "homefeed_category": { "title": "笔记分类", "type": "string", "description": "枚举值通过 `首页推荐-分类` 获取", "default": "" }, "homefeed_search_key": { "title": "搜索关键词", "type": "string", "description": "", "default": "homefeed_recommend" }, "homefeed_need_num": { "title": "客户端实际需要的内容数量", "type": "integer", "description": "这个参数可能与 num 协同工作。例如，num=50 是标准的请求批次大小，但如果客户端检测到当前屏幕只需要18条笔记就能填满，它可能会把这个信息告诉服务器，用于更精细的数据分析或内容预取决策", "default": 18 }, "search_filter_keyword": { "title": "关键词", "type": "string", "description": "", "default": "榴莲" }, "search_note_keyword": { "title": "关键词", "type": "string", "description": "", "default": "榴莲" }, "search_note_page": { "title": "页码", "type": "integer", "description": "", "default": 1 }, "search_note_page_size": { "title": "每页大小", "type": "integer", "description": "", "default": 20 }, "search_note_note_type": { "title": "笔记类型", "enum": [ "0", "2", "1" ], "type": "string", "description": "", "default": "0" }, "search_note_sort_type": { "title": "排序依据", "enum": [ "general", "time_descending", "popularity_descending", "comment_descending", "collect_descending" ], "type": "string", "description": "", "default": "general" }, "search_note_filter_note_type": { "title": "筛选-笔记类型", "enum": [ "不限", "视频笔记", "普通笔记" ], "type": "string", "description": "", "default": "不限" }, "search_note_filter_note_time": { "title": "筛选-发布时间", "enum": [ "不限", "一天内", "一周内", "半年内" ], "type": "string", "description": "", "default": "不限" }, "search_note_filter_note_range": { "title": "筛选-搜索范围", "enum": [ "不限", "已看过", "未看过", "已关注" ], "type": "string", "description": "", "default": "不限" }, "search_note_filter_pos_distance": { "title": "筛选-位置距离", "enum": [ "不限", "同城", "附近" ], "type": "string", "description": "修改这个时, 必须要指定 geo", "default": "不限" }, "search_note_filter_geo": { "title": "筛选-位置距离-geo", "type": "object", "description": "例如: {\"latitude\":1.3450101,\"longitude\":103.9832089}" }, "search_note_filter_hot": { "title": "热词", "type": "string", "description": "枚举值通过 `搜索过滤` 获取", "default": "" }, "search_user_keyword": { "title": "关键词", "type": "string", "description": "", "default": "榴莲" }, "search_user_page": { "title": "页码", "type": "integer", "description": "", "default": 1 }, "search_user_page_size": { "title": "每页大小", "type": "integer", "description": "", "default": 20 }, "user_info_user_id": { "title": "用户ID", "type": "string", "description": "", "default": "5b24961811be105dfe1079d4" }, "user_note_user_id": { "title": "用户ID", "type": "string", "description": "", "default": "5b24961811be105dfe1079d4" }, "user_note_num": { "title": "笔记数量", "type": "integer", "description": "", "default": 30 }, "user_note_cursor": { "title": "分页游标", "type": "string", "description": "从前一页的结果中获取, 第一页为空", "default": "" }, "user_like_note_user_id": { "title": "用户ID", "type": "string", "description": "", "default": "5b24961811be105dfe1079d4" }, "user_like_note_num": { "title": "笔记数量", "type": "integer", "description": "", "default": 30 }, "user_like_note_cursor": { "title": "分页游标", "type": "string", "description": "从前一页的结果中获取, 第一页为空", "default": "" }, "user_collect_note_user_id": { "title": "用户ID", "type": "string", "description": "", "default": "5b24961811be105dfe1079d4" }, "user_collect_note_num": { "title": "笔记数量", "type": "integer", "description": "", "default": 30 }, "user_collect_note_cursor": { "title": "分页游标", "type": "string", "description": "从前一页的结果中获取, 第一页为空", "default": "" }, "note_info_source_note_id": { "title": "笔记ID", "type": "string", "description": "", "default": "68f4e9bf00000000070327cb" }, "note_info_source_xsec_token": { "title": "安全验证-令牌", "type": "string", "description": "", "default": "ABCpkc82MComsYdo8F3jH6QOvcWHx3746fvDysZi8wJTQ=" }, "get_comment_note_id": { "title": "笔记ID", "type": "string", "description": "", "default": "68f4e9bf00000000070327cb" }, "get_comment_xsec_token": { "title": "安全验证-令牌", "type": "string", "description": "", "default": "ABCpkc82MComsYdo8F3jH6QOvcWHx3746fvDysZi8wJTQ=" }, "get_comment_cursor": { "title": "分页游标", "type": "string", "description": "从前一页的结果中获取, 第一页为空", "default": "" }, "get_sub_comment_note_id": { "title": "笔记ID", "type": "string", "description": "", "default": "68f4e9bf00000000070327cb" }, "get_sub_comment_xsec_token": { "title": "安全验证-令牌", "type": "string", "description": "", "default": "ABCpkc82MComsYdo8F3jH6QOvcWHx3746fvDysZi8wJTQ=" }, "get_sub_comment_comment_id": { "title": "一级评论ID", "type": "string", "description": "", "default": "68f599c10000000031002403" }, "get_sub_comment_num": { "title": "评论数量", "type": "integer", "description": "", "default": 10 }, "get_sub_comment_cursor": { "title": "分页游标", "type": "string", "description": "从前一页的结果中获取, 第一页为空", "default": "" }, "like_note_note_id": { "title": "笔记ID", "type": "string", "description": "", "default": "68f4e9bf00000000070327cb" }, "dislike_note_note_id": { "title": "笔记ID", "type": "string", "description": "", "default": "68f4e9bf00000000070327cb" }, "collect_note_note_id": { "title": "笔记ID", "type": "string", "description": "", "default": "68f4e9bf00000000070327cb" }, "uncollect_note_note_id": { "title": "笔记ID", "type": "string", "description": "", "default": "68f4e9bf00000000070327cb" }, "post_comment_note_id": { "title": "笔记ID", "type": "string", "description": "", "default": "68f4e9bf00000000070327cb" }, "post_comment_content": { "title": "评论内容", "type": "string", "description": "", "default": "评论内容示例" }, "post_comment_comment_id": { "title": "评论ID", "type": "string", "description": "为空时给某笔记发布评论, 不为空时给某评论发布评论", "default": "" }, "delete_comment_note_id": { "title": "笔记ID", "type": "string", "description": "", "default": "68f4e9bf00000000070327cb" }, "delete_comment_comment_id": { "title": "评论ID", "type": "string", "description": "删除某笔记的评论 或 删除某评论的评论", "default": "68f5b4b90000000030026de4" }, "like_comment_note_id": { "title": "笔记ID", "type": "string", "description": "", "default": "68f4e9bf00000000070327cb" }, "like_comment_comment_id": { "title": "评论ID", "type": "string", "description": "", "default": "68f599c10000000031002403" }, "dislike_comment_note_id": { "title": "笔记ID", "type": "string", "description": "", "default": "68f4e9bf00000000070327cb" }, "dislike_comment_comment_id": { "title": "评论ID", "type": "string", "description": "", "default": "68f599c10000000031002403" }, "search_topic_keyword": { "title": "关键词", "type": "string", "description": "", "default": "榴莲" }, "search_topic_page": { "title": "页码", "type": "integer", "description": "", "default": 1 }, "search_topic_page_size": { "title": "每页大小", "type": "integer", "description": "", "default": 20 }, "create_topic_topic_names": { "title": "话题名称", "type": "string", "description": "", "default": "榴莲" }, "search_location_keyword": { "title": "关键词", "type": "string", "description": "", "default": "北京" }, "search_location_page": { "title": "页码", "type": "integer", "description": "", "default": 1 }, "search_location_size": { "title": "每页大小", "type": "integer", "description": "", "default": 50 }, "publish_note_images": { "title": "图片列表", "type": "array", "description": "图片URL列表", "items": { "type": "string" } }, "publish_note_title": { "title": "标题", "type": "string", "description": "", "default": "标题示例" }, "publish_note_desc": { "title": "正文内容", "type": "string", "description": "", "default": "正文内容示例... #topic1[话题]# #topic2[话题]#" }, "publish_note_topics": { "title": "话题列表", "type": "array", "description": "如果已有话题则直接引用, 如果没有话题会创建话题后引用。配置话题列表后(例如: [\"topic1\",\"topic2\"]), 正文内容仍要引用(例如: 正文内容示例... #topic1[话题]# #topic2[话题]#)才会生效", "items": { "type": "string" } }, "publish_note_location": { "title": "地点", "type": "string", "description": "实际会根据入参选择最近(系统推荐)的地点, 可能与输入不完全一致", "default": "北京" } } }, "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 } } } } } } } } } }