{
  "openapi": "3.0.1",
  "info": {
    "title": "RedNote Scraper (Xiaohongshu)",
    "description": "Scrape RedNote (Xiaohongshu, 小红书) without an account: notes from keyword search and creator profiles with likes, saves, comments, shares, tags, images and video links, plus note comments with replies. Search sort and filters. Chinese or English keywords. JSON, CSV, Excel.",
    "version": "0.1",
    "x-build-id": "g3tmr63TrHFfMkjjD"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/blueskyscraper~rednote-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-blueskyscraper-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/blueskyscraper~rednote-scraper/runs": {
      "post": {
        "operationId": "runs-sync-blueskyscraper-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/blueskyscraper~rednote-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-blueskyscraper-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",
        "properties": {
          "keywords": {
            "title": "🔍 Search keywords",
            "type": "array",
            "description": "Chinese or English: <code>护肤</code>, <code>skincare routine</code>, <code>巴厘岛</code>. Each keyword returns notes as RedNote's search shows them.",
            "items": {
              "type": "string"
            }
          },
          "userUrls": {
            "title": "👤 Creator profiles",
            "type": "array",
            "description": "Profile link or user ID: <code>https://www.xiaohongshu.com/user/profile/5db2781e0000000001009db4</code>, or an <code>xhslink.com</code> share link. Returns the creator's notes.",
            "items": {
              "type": "string"
            }
          },
          "noteUrls": {
            "title": "💬 Note links (comments)",
            "type": "array",
            "description": "Note link or ID: <code>https://www.xiaohongshu.com/explore/6a3284d6000000001702e30f</code>, or an <code>xhslink.com</code> share link. Returns the note's comments.",
            "items": {
              "type": "string"
            }
          },
          "sortBy": {
            "title": "↕️ Search order",
            "enum": [
              "general",
              "newest",
              "popular",
              "comments",
              "saves"
            ],
            "type": "string",
            "description": "Search: RedNote's own orders.",
            "default": "general"
          },
          "noteType": {
            "title": "🎞️ Note type",
            "enum": [
              "any",
              "video",
              "image"
            ],
            "type": "string",
            "description": "Search: video notes, image notes or both.",
            "default": "any"
          },
          "publishedWithin": {
            "title": "📅 Published within",
            "enum": [
              "any",
              "day",
              "week",
              "halfyear"
            ],
            "type": "string",
            "description": "Search: only recent notes.",
            "default": "any"
          },
          "commentSort": {
            "title": "↕️ Comment order",
            "enum": [
              "default",
              "newest",
              "likes"
            ],
            "type": "string",
            "description": "Note links: order of the comments.",
            "default": "default"
          },
          "includeReplies": {
            "title": "💬 Add replies",
            "type": "boolean",
            "description": "Note links: add the replies RedNote shows under each comment.",
            "default": true
          },
          "exploreCategories": {
            "title": "🧭 Explore categories (no keywords)",
            "type": "array",
            "description": "Discover topics without knowing their names: RedNote's home feed per category, 40 notes a request (title, author, type, likes). It is a recommendation sample, not the whole market — each row says so.",
            "items": {
              "type": "string",
              "enum": [
                "food",
                "fashion",
                "cosmetics",
                "home",
                "travel",
                "fitness",
                "movies_tv",
                "career",
                "relationships",
                "gaming",
                "kpop",
                "video",
                "recommended"
              ],
              "enumTitles": [
                "Food 美食",
                "Fashion 穿搭",
                "Make-up 彩妆",
                "Home 家居",
                "Travel 旅行",
                "Fitness 健身",
                "Movies & TV 影视",
                "Career 职场",
                "Relationships 情感",
                "Gaming 游戏",
                "K-pop",
                "Video 视频",
                "Recommended 推荐"
              ]
            }
          },
          "refreshNotes": {
            "title": "🔁 Re-measure notes (by link or ID)",
            "type": "array",
            "description": "Links or IDs of notes you already track. Returns each note again with today's likes, saves, comments and shares — available now, billed as a note row ($0.045 per re-measured note from 16 November 2026, when its own price starts).",
            "items": {
              "type": "string"
            }
          },
          "maxResultsPerInput": {
            "title": "💯 Results per input",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Cap for each keyword, creator or note: notes per search or creator; comments per note.",
            "default": 50
          },
          "maxItems": {
            "title": "Maximum rows per run",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Stop after this many rows in the whole run — a hard ceiling on cost.",
            "default": 10000
          },
          "monitoringStoreName": {
            "title": "🔔 Monitoring mode — store name",
            "type": "string",
            "description": "Give the run a name (e.g. <code>brand-mentions</code>) and every later run with the same name returns <b>only rows it has not delivered before</b>. Empty = normal run."
          },
          "dataContract": {
            "title": "🧾 Data contract (provenance + null reasons)",
            "type": "boolean",
            "description": "Adds to every row a <code>provenance</code> block (platform, upstream API, endpoint, mode, source ID, canonical URL, observedAt / collectedAt, schema version, checksum of ID + counters, <code>rawChecksum</code> of the source record) and a <code>metrics</code> block where every counter is a value or <code>null</code> with the reason — never a fake zero. On by default; switch off for plain rows.",
            "default": true
          },
          "authorPrivacy": {
            "title": "🕶️ Author data",
            "enum": [
              "full",
              "pseudonymous"
            ],
            "type": "string",
            "description": "Default: Pseudonymous. Choose Full to get author names, IDs and profile links. Pseudonymous replaces author names, IDs, links and avatars with <code>authorKey</code> — a salted, stable hash (one key per author on the platform's stable id, the same in every mode; deleted authors get none) that still lets you measure how concentrated a topic is, without storing profiles. Profile inputs are replaced by the same key in <code>sourceInput</code>; sound titles named after a creator and Reddit <code>u_…</code> profile links are masked too. @mentions inside post, comment and title text become <code>@user_&lt;hash&gt;</code> (Reddit <code>u/name</code> → <code>u/user_&lt;hash&gt;</code>) — the same hash for the same handle in every run; e-mail addresses and #hashtags stay as written.",
            "default": "pseudonymous"
          },
          "stripSignedTokens": {
            "title": "✂️ Remove signed tokens from links",
            "type": "boolean",
            "description": "Removes signed parameters (xsec_token, expiring media signatures) from links and drops signed video file links. On by default (and always on with pseudonymous authors).",
            "default": true
          },
          "snapshotId": {
            "title": "🏷️ Snapshot id",
            "type": "string",
            "description": "Optional label of this snapshot (e.g. the date), written into provenance of every row."
          },
          "panelId": {
            "title": "🏷️ Panel id / version",
            "type": "string",
            "description": "Optional id of your fixed panel of posts, written into provenance. With Re-measure IDs it also keeps a <b>panel journal</b> between runs: free <code>panel_change</code> rows say which IDs were added, removed from your input or are still in the panel but gone on the source (with the date they joined and the previous run time), <code>panelVersion</code> goes up whenever the membership changes, and the run's key-value store gets a <code>PANEL</code> record with the full membership."
          },
          "queryId": {
            "title": "🏷️ Query id / version",
            "type": "string",
            "description": "Optional id of your search profile version, written into provenance."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}