{
  "openapi": "3.0.1",
  "info": {
    "title": "Xiaohongshu (RedNote) Scraper & API | EveryInfra",
    "description": "EveryInfra Xiaohongshu (RedNote) data Actor for English-speaking developers and analysts on Apify Store; 12 active operations. First 3 accepted data-request attempts per Apify account are free of result-event charges, shared across all EveryInfra Actors.",
    "version": "0.0",
    "x-build-id": "GrQPDBGFIba6GtUbp"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/blushing_parachute~everyinfra-xiaohongshu-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-blushing_parachute-everyinfra-xiaohongshu-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/blushing_parachute~everyinfra-xiaohongshu-api/runs": {
      "post": {
        "operationId": "runs-sync-blushing_parachute-everyinfra-xiaohongshu-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/blushing_parachute~everyinfra-xiaohongshu-api/run-sync": {
      "post": {
        "operationId": "run-sync-blushing_parachute-everyinfra-xiaohongshu-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",
        "properties": {
          "action": {
            "title": "Operation",
            "enum": [
              "search",
              "note",
              "comments",
              "sub_comments",
              "user_post",
              "user_info",
              "user_followers",
              "user_search",
              "topic",
              "product_search",
              "product_detail",
              "product_review"
            ],
            "type": "string",
            "description": "12 App actions for scraping Xiaohongshu notes, posts, comments, users, followers and products: search, note, comments, sub_comments, user_post, user_info, user_followers, user_search, topic, product_search, product_detail, product_review.",
            "default": "search"
          },
          "keyword": {
            "title": "keyword",
            "maxLength": 4096,
            "type": "string",
            "description": "Search keyword. Applicable to: search, user_search, product_search"
          },
          "note_id": {
            "title": "note_id",
            "maxLength": 4096,
            "type": "string",
            "description": "Note ID. Applicable to: note, comments, sub_comments"
          },
          "user_id": {
            "title": "user_id",
            "maxLength": 4096,
            "type": "string",
            "description": "User ID. Applicable to: user_post, user_info, user_followers"
          },
          "comment_id": {
            "title": "comment_id",
            "maxLength": 4096,
            "type": "string",
            "description": "Comment ID. Applicable to: sub_comments"
          },
          "topic_id": {
            "title": "topic_id",
            "maxLength": 4096,
            "type": "string",
            "description": "Topic ID. Applicable to: topic"
          },
          "sku_id": {
            "title": "sku_id",
            "maxLength": 4096,
            "type": "string",
            "description": "SKU ID. Applicable to: product_detail"
          },
          "new_sku_id": {
            "title": "new_sku_id",
            "maxLength": 4096,
            "type": "string",
            "description": "New SKU ID. Applicable to: product_review"
          },
          "page": {
            "title": "page",
            "minimum": 0,
            "maximum": 1000000,
            "type": "integer",
            "description": "Page number. Applicable to: search, user_search, product_search, product_review. Action-specific accepted values/defaults are in README."
          },
          "page_size": {
            "title": "page_size",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Requested page_size/num is NOT a strict result cap: a source page may contain more or fewer rows. Applicable to: search."
          },
          "num": {
            "title": "num",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Items per page. Applicable to: search (alias of page_size), comments, sub_comments. Requested page_size/num is NOT a strict result cap: a source page may contain more or fewer rows."
          },
          "cursor": {
            "title": "cursor",
            "maxLength": 4096,
            "type": "string",
            "description": "Pagination cursor. Applicable to: comments, sub_comments, user_post, user_followers"
          },
          "search_id": {
            "title": "search_id",
            "maxLength": 4096,
            "type": "string",
            "description": "Search ID. Applicable to: search"
          },
          "session_id": {
            "title": "session_id",
            "maxLength": 4096,
            "type": "string",
            "description": "Session ID. Applicable to: search"
          },
          "last_note_ct": {
            "title": "last_note_ct",
            "maxLength": 4096,
            "type": "string",
            "description": "Last note creation time. Applicable to: topic"
          },
          "last_note_id": {
            "title": "last_note_id",
            "maxLength": 4096,
            "type": "string",
            "description": "Last note ID. Applicable to: topic"
          },
          "cursor_score": {
            "title": "cursor_score",
            "maxLength": 4096,
            "type": "string",
            "description": "Pagination cursor score. Applicable to: topic"
          },
          "sort": {
            "title": "sort",
            "maxLength": 4096,
            "type": "string",
            "description": "Sort method. Applicable to: search, comments, topic, product_search. Action-specific accepted values/defaults are in README."
          },
          "note_type": {
            "title": "note_type",
            "maxLength": 4096,
            "type": "string",
            "description": "Note type filter. Applicable to: search"
          },
          "note_range": {
            "title": "note_range",
            "maxLength": 4096,
            "type": "string",
            "description": "Note range filter. Applicable to: search"
          },
          "note_time": {
            "title": "note_time",
            "maxLength": 4096,
            "type": "string",
            "description": "Time range filter. Applicable to: search"
          },
          "node_type": {
            "title": "node_type",
            "maxLength": 4096,
            "type": "string",
            "description": "Node type. Applicable to: note"
          },
          "fans_count": {
            "title": "fans_count",
            "maxLength": 4096,
            "type": "string",
            "description": "Fans count filter. Applicable to: user_search"
          },
          "user_type": {
            "title": "user_type",
            "maxLength": 4096,
            "type": "string",
            "description": "User type filter. Applicable to: user_search"
          },
          "filters_tags": {
            "title": "filters_tags",
            "maxItems": 20,
            "type": "array",
            "description": "Filters tags array. Applicable to: product_search",
            "items": {
              "type": "string",
              "maxLength": 100
            }
          },
          "sort_strategy_type": {
            "title": "sort_strategy_type",
            "maxLength": 4096,
            "type": "string",
            "description": "Sort strategy. Applicable to: product_review"
          },
          "params": {
            "title": "Operation parameters",
            "type": "object",
            "description": "Optional advanced JSON object under 'params' key. Existing clients can continue using nested input format."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}