{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu Pugongying KOL Data: Creators, Fans, Notes", "description": "RedNote (Xiaohongshu) creator marketplace (Pugongying) data for influencer marketing: creator profiles, overview, note performance, core data, follower profiles and trends, plus note search with follower filters. Pay per section or note.", "version": "1.0", "x-build-id": "tKEH0j2vVvuyPAzfK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/qovia~xiaohongshu-pugongying-kol-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-qovia-xiaohongshu-pugongying-kol-data", "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/qovia~xiaohongshu-pugongying-kol-data/runs": { "post": { "operationId": "runs-sync-qovia-xiaohongshu-pugongying-kol-data", "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/qovia~xiaohongshu-pugongying-kol-data/run-sync": { "post": { "operationId": "run-sync-qovia-xiaohongshu-pugongying-kol-data", "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": [ "mode" ], "properties": { "mode": { "title": "What to get", "enum": [ "creators", "search", "notes" ], "type": "string", "description": "Creator data for given creators, a keyword search of notes, or details of given notes.", "default": "creators" }, "urls": { "title": "Creator or note URLs / IDs", "type": "array", "description": "Creator data: RedNote profile or Pugongying creator URLs, or 24-character user IDs. Note details: note URLs or 24-character note IDs.", "items": { "type": "string" } }, "sections": { "title": "Creator sections", "type": "array", "description": "Which data to get for each creator. Each section is charged once per creator.", "items": { "type": "string", "enum": [ "profile", "overview", "notePerformance", "coreData", "fansSummary", "fansProfile", "fansTrend", "recentNotes" ], "enumTitles": [ "Profile", "Overview (reads, engagement, costs)", "Note performance", "Core data (daily)", "Follower summary", "Follower profile (age, gender, interests, cities)", "Follower trend", "Recent notes" ] }, "default": [ "profile", "overview", "fansProfile" ] }, "keywords": { "title": "Search keywords", "type": "array", "description": "One search per keyword. Chinese keywords match far more notes than English ones.", "items": { "type": "string" } }, "sort": { "title": "Sort search results by", "enum": [ "hot", "impNum", "readNum", "engageNum", "fansNum" ], "type": "string", "description": "Order of search results.", "default": "hot" }, "followersMin": { "title": "Creator followers, at least", "minimum": 0, "type": "integer", "description": "Only notes by creators with at least this many followers." }, "followersMax": { "title": "Creator followers, at most", "minimum": 0, "type": "integer", "description": "Only notes by creators with at most this many followers." }, "maxItems": { "title": "Max notes per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Notes per keyword.", "default": 100 } } }, "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 } } } } } } } } } }