{ "openapi": "3.0.1", "info": { "title": "Shopee Shop & Seller Profile Scraper", "description": "Scrape Shopee sellers across 11 countries: star ratings with the good/normal/bad split, followers, listing counts, response rate and time, cancellation rate, badges and shop age - plus the shop's featured product with its live price, stock and units sold. Feed it shop URLs, usernames or IDs.", "version": "1.0", "x-build-id": "HGTPtrKoxKPOgns5t" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/incognito_mode~shopee-shop-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-incognito_mode-shopee-shop-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/incognito_mode~shopee-shop-scraper/runs": { "post": { "operationId": "runs-sync-incognito_mode-shopee-shop-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/incognito_mode~shopee-shop-scraper/run-sync": { "post": { "operationId": "run-sync-incognito_mode-shopee-shop-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": { "shops": { "title": "Shops", "type": "array", "description": "One entry per seller. Any of these work, and you can mix them freely:\n\n• Shop URL — https://shopee.sg/shop/142401765\n• Seller page URL — https://shopee.sg/abbott_official\n• Any product URL — the shop is read from it\n• Numeric shop ID — 142401765\n• Seller username — abbott_official\n\nIf a URL points at another country's Shopee (shopee.co.id, shopee.com.br …), that country is used for that row regardless of the Marketplace setting below — so a mixed-country list works in one run.", "items": { "type": "string" } }, "region": { "title": "Marketplace", "enum": [ "sg", "my", "id", "th", "vn", "ph", "tw", "br", "mx", "co", "cl" ], "type": "string", "description": "Which Shopee country to use for entries that are NOT full URLs (bare usernames and numeric IDs). Full URLs always use their own domain.", "default": "sg" }, "includeFeaturedItem": { "title": "Include the shop's featured product (with price)", "type": "boolean", "description": "Adds one extra request per shop and returns the seller's featured listing with its real price, discount, stock, units sold and star breakdown. This is the only public Shopee source that still carries a live price, so leave it on unless you only need seller metrics.", "default": true }, "maxItems": { "title": "Maximum shops", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on how many shops are stored. The run stops as soon as it is reached.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Leave off. Every request calls Shopee directly first, which costs nothing. If an IP is blocked the Actor escalates on its own: first to a datacenter proxy (included in every Apify plan, free tier included), then to residential only if your plan has it. No residential add-on is required.", "default": { "useApifyProxy": 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 } } }, "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 } } } } } } } } } }