{ "openapi": "3.0.1", "info": { "title": "Xueqiu Scraper — Chinese Stock Discussion & Cashtag Sentiment", "description": "Extract Chinese stock sentiment from Xueqiu (Snowball) — Sina's Stocktwits with 20M+ users. A-share, HK, and US-listed-Chinese tickers. Per-post cashtag extraction, KOL metrics. Built for equity research, quant alt-data, AI training corpora. No login required.", "version": "0.1", "x-build-id": "jw51VEhuuBNDY549O" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zhorex~xueqiu-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zhorex-xueqiu-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/zhorex~xueqiu-scraper/runs": { "post": { "operationId": "runs-sync-zhorex-xueqiu-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/zhorex~xueqiu-scraper/run-sync": { "post": { "operationId": "run-sync-zhorex-xueqiu-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "ticker_posts", "ticker_quote", "user_posts", "user_profile", "trending", "post_search" ], "type": "string", "description": "What to scrape from Xueqiu. Each mode targets a different data slice — see README for details.", "default": "ticker_posts" }, "tickers": { "title": "Tickers", "type": "array", "description": "Stock tickers in ANY format: TSLA, $TSLA, 00700, 00700.HK, 600519, SH600519. Used in ticker_posts and ticker_quote modes.", "items": { "type": "string" } }, "userIds": { "title": "Xueqiu user IDs", "type": "array", "description": "Xueqiu user IDs or profile URLs. Find in profile URL: xueqiu.com/u/{userId}. Used in user_posts and user_profile modes.", "items": { "type": "string" } }, "searchQuery": { "title": "Search query", "type": "string", "description": "Free-text search query in Chinese or English. Used in post_search mode." }, "postsPerTicker": { "title": "Posts per ticker", "minimum": 1, "maximum": 500, "type": "integer", "description": "Max posts to fetch per ticker in ticker_posts mode.", "default": 50 }, "postsPerUser": { "title": "Posts per user", "minimum": 1, "maximum": 500, "type": "integer", "description": "Max posts to fetch per user in user_posts mode.", "default": 50 }, "sort": { "title": "Sort order", "enum": [ "latest", "popular" ], "type": "string", "description": "Sort order for ticker_posts and post_search. 'latest' = newest first, 'popular' = re-ranked by engagement.", "default": "latest" }, "dateFrom": { "title": "Date from (optional)", "type": "string", "description": "ISO date (YYYY-MM-DD) — filter posts published on or after this date." }, "dateTo": { "title": "Date to (optional)", "type": "string", "description": "ISO date (YYYY-MM-DD) — filter posts published on or before this date." }, "includeRetweets": { "title": "Include retweets", "type": "boolean", "description": "Include retweets in output. Default false for cleaner signal.", "default": false }, "maxResults": { "title": "Max results (cap)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on total items across all tickers / users / pages.", "default": 1000 }, "cookieString": { "title": "Cookie string (optional)", "type": "string", "description": "Optional cookies for higher rate limits. Open xueqiu.com in your browser, DevTools → Application → Cookies, paste the full Cookie header here. Not required — the scraper works without login." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy configuration. RESIDENTIAL proxies are recommended for high-volume runs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }