{ "openapi": "3.0.1", "info": { "title": "SHEIN Scraper", "description": "Scrape SHEIN product listings by keyword, product ID, or URL. Returns prices, ratings, images, and optional reviews.", "version": "1.0", "x-build-id": "c10EHcnLtJc9gVheO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datascrapers~shein-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datascrapers-shein-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/datascrapers~shein-scraper/runs": { "post": { "operationId": "runs-sync-datascrapers-shein-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/datascrapers~shein-scraper/run-sync": { "post": { "operationId": "run-sync-datascrapers-shein-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": { "searchQueries": { "title": "Search Queries", "type": "array", "description": "Keywords to search on SHEIN (for example \"dress\" or \"winter jacket\"). Primary input for agents — no URL required.", "items": { "type": "string" } }, "productIds": { "title": "Product IDs", "type": "array", "description": "SHEIN goods IDs to fetch directly (for example \"21628421\").", "items": { "type": "string" } }, "startUrls": { "title": "Product or Search URLs", "type": "array", "description": "Optional SHEIN product pages or search URLs, for example https://us.shein.com/floral-dress-p-21628421.html or a keyword search URL.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "sort": { "title": "Sort", "enum": [ "recommend", "newest", "price_asc", "price_desc", "popular" ], "type": "string", "description": "How to order keyword search results.", "default": "recommend" }, "country": { "title": "Country", "enum": [ "US", "GB", "FR", "DE", "IT", "ES", "NL", "PL", "AE", "SA", "JP", "KR", "IN", "SG", "AU", "CA", "MX", "BR", "AL", "AD", "AR", "AM", "AT", "BH", "BE", "BA", "BG", "BY", "CL", "CO", "HR", "CY", "CZ", "DK", "EC", "EE", "FI", "GE", "GR", "HK", "HU", "IS", "ID", "IE", "IL", "JO", "XK", "KW", "LV", "LB", "LI", "LT", "LU", "MY", "MT", "MC", "MD", "ME", "MA", "NZ", "MK", "NO", "OM", "PE", "PH", "PT", "PR", "QA", "RO", "RU", "RS", "SK", "SI", "SM", "ZA", "SE", "CH", "TH", "TR", "TW", "UA", "VA", "VN" ], "type": "string", "description": "SHEIN store. Currency and residential proxy country are set automatically (Japan → JPY + JP proxy, UAE → AED + AE proxy). The bundled identity covers the common/aws stores (Middle East, Asia, Americas, Oceania).", "default": "AE" }, "includeReviews": { "title": "Include Reviews", "type": "boolean", "description": "Attach customer reviews to each product record.", "default": false }, "maxReviewsPerProduct": { "title": "Max Reviews Per Product", "minimum": 0, "type": "integer", "description": "Maximum reviews to attach when Include Reviews is enabled.", "default": 20 }, "includeDetails": { "title": "Include Extra Details", "type": "boolean", "description": "Attach size, material, and live price fields when the store returns them. Some extra-detail requests are skipped automatically.", "default": false }, "maxItems": { "title": "Max Items", "minimum": 0, "type": "integer", "description": "Maximum number of products to scrape (0 = unlimited).", "default": 0 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Residential proxies. The Actor always sets the proxy country to the selected store country.", "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 }, "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 } } } } } } } } } }