{ "openapi": "3.0.1", "info": { "title": "Shopee Seller & Shop Intelligence Scraper", "description": "Get Shopee seller & shop profiles from product URLs, shop URLs, IDs or usernames in any Shopee region: shop name, ID, rating, rating count, followers and logo, plus listings, badges and account signals when Shopee's shop API answers. Structured JSON for lead-gen and seller research.", "version": "1.0", "x-build-id": "LZ5Pmi59mbC5HHZiz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axlymxp~shopee-seller-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axlymxp-shopee-seller-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/axlymxp~shopee-seller-scraper/runs": { "post": { "operationId": "runs-sync-axlymxp-shopee-seller-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/axlymxp~shopee-seller-scraper/run-sync": { "post": { "operationId": "run-sync-axlymxp-shopee-seller-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": [ "shops" ], "properties": { "shops": { "title": "Shops to scrape", "minItems": 1, "type": "array", "description": "One entry per Shopee shop. Each entry can be a product URL (e.g. https://shopee.co.id/xxx-i.88053496.8152544433), a shop/storefront URL (https://shopee.co.id/shop/88053496 or https://shopee.co.id/windowfashionsurabaya), a bare shop ID (88053496), or a username (windowfashionsurabaya). Full URLs carry their own region; bare IDs/usernames use the Region below.", "items": { "type": "string" } }, "region": { "title": "Default region", "enum": [ "co.id", "sg", "com.my", "co.th", "vn", "ph", "com.br", "com.mx", "tw" ], "type": "string", "description": "Shopee region used for bare shop IDs and usernames (ignored for full URLs, which carry their own host). Indonesia is the primary, fully-verified market.", "default": "co.id" }, "dataSource": { "title": "Data source", "enum": [ "auto", "shopPage", "shopApi" ], "type": "string", "description": "auto (recommended): check Shopee's shop API once and, while Shopee refuses it (since early November 2026 it answers HTTP 418 in every region), read the public shop page instead. shopPage: only the public shop page (shop name, username, shop ID, logo, rating, rating count, follower count as displayed). shopApi: only the shop API (full profile: listings, rating breakdown, badges, account signals, dates); the run fails while Shopee gates it.", "default": "auto" }, "maxItems": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Stop after this many shop profiles.", "default": 1000 }, "maxRetries": { "title": "Max request attempts", "minimum": 0, "maximum": 10, "type": "integer", "description": "Total attempts per HTTP request. Set to 0 (or 1) for a single attempt with no retries and no backoff sleeps. Higher values retry transient network errors, 429, 502 and 503 with exponential backoff.", "default": 4 }, "stopOnBlock": { "title": "Stop the whole run on the first block", "type": "boolean", "description": "Abort the run as soon as Shopee returns a CAPTCHA / verification page, HTTP 401, 403, 418 or 429 for the selected data source. No further requests are made and no fallback IP or proxy is tried. In Auto mode the one-time shop API check that selects the data source does not count as a block. Combine with Max request attempts = 0 for a strict single-shot probe.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify proxy. The shop page and the shop API are requested without a proxy by default; enable one only if you need a specific egress region or want to distribute requests.", "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 }, "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 } } } } } } } } } }