{ "openapi": "3.0.1", "info": { "title": "SHEIN Product Scraper - Prices, Discounts, Ratings & Fit", "description": "Scrape SHEIN products from keyword searches, category ids and listing links on 6 storefronts (US, CA, AU, DE, ES, NL): price, original price, discount, rating, review count, size fit, brand, store, category, images, colour variants. Filters, price-drop monitor, no login.", "version": "0.1", "x-build-id": "EPujRGrbkzGkkcAVx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/topapi~shein-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-topapi-shein-product-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/topapi~shein-product-scraper/runs": { "post": { "operationId": "runs-sync-topapi-shein-product-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/topapi~shein-product-scraper/run-sync": { "post": { "operationId": "run-sync-topapi-shein-product-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": { "searchTerms": { "title": "๐Ÿ” Search terms", "type": "array", "description": "Keywords to search on SHEIN, one per line, e.g. \"summer dress\", \"cargo pants\", \"phone case\". Each term is its own search.", "items": { "type": "string" } }, "startUrls": { "title": "๐Ÿ”— Listing URLs", "type": "array", "description": "SHEIN category, search or selection links, e.g. https://us.shein.com/Women-Dresses-c-1727.html or https://us.shein.com/pdsearch/hoodie/. Filters already in the link are kept.", "items": { "type": "string" } }, "categoryIds": { "title": "๐Ÿ—‚๏ธ Category ids", "type": "array", "description": "SHEIN category ids: the number after -c- in a category link, e.g. 1727 (Women Short Dresses), 1766 (Women Tops).", "items": { "type": "string" } }, "country": { "title": "๐ŸŒ Storefront", "enum": [ "us", "ca", "au", "de", "es", "nl" ], "type": "string", "description": "Which SHEIN storefront to read for keywords and category ids. Prices and currency follow it. A link keeps its own storefront.", "default": "us" }, "sortBy": { "title": "โ†•๏ธ Sort by", "enum": [ "recommended", "newest", "most-popular", "top-rated", "price-asc", "price-desc" ], "type": "string", "description": "SHEIN's own sort order for the listing.", "default": "recommended" }, "widerSearch": { "title": "๐Ÿ”ญ Wider search", "type": "boolean", "description": "SHEIN shows a script the first 20 products of a listing. On: also open the search under SHEIN's other sort orders and its own price bands (20 more each) until your caps are met.", "default": true }, "minPrice": { "title": "๐Ÿ’ฒ Min price", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Only products at or above this price, in the storefront's currency (e.g. 10). Empty = no minimum." }, "maxPrice": { "title": "๐Ÿ’ฒ Max price", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Only products at or below this price, in the storefront's currency (e.g. 30). Empty = no maximum." }, "onSaleOnly": { "title": "๐Ÿท๏ธ Discounted only", "type": "boolean", "description": "Only products whose price is below their original price.", "default": false }, "minDiscountPercent": { "title": "๐Ÿ“‰ Min discount %", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only products discounted by at least this many percent, e.g. 30. Empty = any." }, "minRating": { "title": "โญ Min rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only products rated at least this (0-5), e.g. 4.5. Products with no rating are left out when set." }, "minReviews": { "title": "๐Ÿ’ฌ Min reviews", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Only products with at least this many reviews, e.g. 100." }, "quickShipOnly": { "title": "๐Ÿšš Quick Ship only", "type": "boolean", "description": "Only products SHEIN flags for Quick Ship (local warehouse).", "default": false }, "includeKeywords": { "title": "โœ… Title must contain", "type": "array", "description": "Keep a product only if its title contains one of these words, e.g. \"linen\", \"maxi\".", "items": { "type": "string" } }, "excludeKeywords": { "title": "๐Ÿšซ Title must not contain", "type": "array", "description": "Drop a product whose title contains any of these words, e.g. \"plus size\".", "items": { "type": "string" } }, "monitorMode": { "title": "๐Ÿ” Monitor mode", "type": "boolean", "description": "Deliver only products not delivered by earlier monitor runs of the same search. Pairs with a daily schedule.", "default": false }, "monitorPriceChanges": { "title": "๐Ÿ’น Also report price changes", "type": "boolean", "description": "In monitor mode, also deliver a product seen before whose price changed (changeType PRICE_DROP / PRICE_UP with previousPrice).", "default": false }, "monitorStoreName": { "title": "๐Ÿ—„๏ธ Monitor store name", "type": "string", "description": "Named key-value store that remembers delivered products between runs. Use a different name per project.", "default": "shein-product-monitor" }, "maxResults": { "title": "๐Ÿ”ข Max products", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Most products to deliver in this run across all searches. 0 = no limit. SHEIN serves ~10 listing screens of 20 products per run (see README).", "default": 50 }, "maxResultsPerSearch": { "title": "๐Ÿ”ข Max per search", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Most products per search term, category or link (wider search stops once it is reached). 0 = only Max products applies.", "default": 0 }, "compact": { "title": "๐Ÿงพ Compact output", "type": "boolean", "description": "Core fields only (id, title, link, prices, discount, rating, reviews, stock, category, brand, image) - trimmed for AI / MCP pipelines.", "default": false }, "proxyConfiguration": { "title": "๐Ÿ›ก๏ธ Proxy", "type": "object", "description": "Connection for the browser. Default: the run's own connection (no proxy). Apify Proxy datacenter also works. Residential is not needed; if chosen, its spend is capped.", "default": { "useApifyProxy": false } }, "debug": { "title": "๐Ÿž Debug network log", "type": "boolean", "description": "Save the browser's SHEIN request log to the key-value store (NETLOG_).", "default": false } } }, "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 } } } } } } } } } }