{ "openapi": "3.0.1", "info": { "title": "Shopee Api Scraper", "description": "Query Shopee's unofficial API for product searches by keyword, category, or shop. Access detailed information including prices, orders, stock levels, and ratings. Also retrieve related entities like the category tree, shop listings, and keyword suggestions.", "version": "1.7", "x-build-id": "7dLRAyPJFBIjsdEhM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/chartedsea~shopee-api-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-chartedsea-shopee-api-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/chartedsea~shopee-api-scraper/runs": { "post": { "operationId": "runs-sync-chartedsea-shopee-api-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/chartedsea~shopee-api-scraper/run-sync": { "post": { "operationId": "run-sync-chartedsea-shopee-api-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": [ "requests" ], "properties": { "requests": { "title": "Shopee Web requests", "minItems": 1, "maxItems": 100, "type": "array", "description": "One to 100 Shopee Web requests. Each request is processed and billed independently.", "items": { "type": "object", "properties": { "url": { "title": "Shopee Web URL", "type": "string", "description": "Shopee Web page or backend API URL to scrape." }, "method": { "title": "HTTP method", "type": "string", "description": "Use POST for supported Shopee POST APIs.", "enum": [ "GET", "POST" ], "default": "GET" }, "payload": { "title": "POST payload", "type": "object", "description": "Optional JSON payload for a supported Shopee POST API.", "editor": "json" }, "userData": { "title": "Request metadata", "type": "object", "description": "Optional referrer, language, and scraper metadata.", "editor": "json" }, "language": { "title": "Language", "type": "string", "description": "Override the Shopee language header and cookie for this request." }, "enrichUrlQuery": { "title": "Enrich URL query", "type": "boolean", "description": "Automatically add required Shopee query parameters for this request." }, "generateReferrer": { "title": "Generate referrer", "type": "boolean", "description": "Generate a realistic Shopee referrer for this request." }, "emulateMobileDevice": { "title": "Emulate mobile device", "type": "boolean", "description": "Emulate Shopee mobile web traffic for this request." } }, "required": [ "url" ], "additionalProperties": true } }, "language": { "title": "Language", "type": "string", "description": "Default Shopee language header and cookie for the request batch." }, "enrichUrlQuery": { "title": "Enrich URL queries", "type": "boolean", "description": "Automatically add required Shopee query parameters unless overridden.", "default": true }, "generateReferrer": { "title": "Generate referrers", "type": "boolean", "description": "Generate realistic Shopee referrers unless overridden.", "default": true }, "emulateMobileDevice": { "title": "Emulate mobile device", "type": "boolean", "description": "Emulate Shopee mobile web traffic unless overridden.", "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 } } }, "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 } } } } } } } } } }