{ "openapi": "3.0.1", "info": { "title": "Tokopedia Scraper – Products, Prices, Sellers & Variants", "description": "Extract product data from Tokopedia, Indonesia’s largest marketplace. Search by keyword with sorting and filters, or use product/result URLs. Returns price, discount, rating, sold count, seller, category, images, and optional details like description, videos, variants, and wholesale tiers.", "version": "1.0", "x-build-id": "dGTjbtKVvUeeWGIfq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~tokopedia-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-tokopedia-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/abotapi~tokopedia-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-tokopedia-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/abotapi~tokopedia-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-tokopedia-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "url" ], "type": "string", "description": "Choose Search to build queries from keywords and filters, or URL to scrape pasted product or result-page URLs directly.", "default": "search" }, "searchTerms": { "title": "Search keywords", "type": "array", "description": "One or more keywords to search for, e.g. \"sepatu\", \"laptop\", \"iphone\".", "default": [], "items": { "type": "string" } }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "most_reviewed", "price_asc", "price_desc" ], "type": "string", "description": "Result ordering.", "default": "relevance" }, "minPrice": { "title": "Minimum price (IDR)", "minimum": 0, "type": "integer", "description": "Only keep products at or above this price, in Indonesian Rupiah." }, "maxPrice": { "title": "Maximum price (IDR)", "minimum": 0, "type": "integer", "description": "Only keep products at or below this price, in Indonesian Rupiah." }, "condition": { "title": "Condition", "enum": [ "any", "new", "used" ], "type": "string", "description": "Keep only products that match this condition.", "default": "any" }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "integer", "description": "Only keep products with an average rating at or above this value (1-5)." }, "shopTier": { "title": "Seller type", "enum": [ "any", "official_store", "power_merchant" ], "type": "string", "description": "Keep only products from this type of seller.", "default": "any" }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "Keep only products eligible for free shipping.", "default": false }, "discountOnly": { "title": "Discounted products only", "type": "boolean", "description": "Keep only products with an active discount.", "default": false }, "urls": { "title": "Product or result URLs", "type": "array", "description": "Paste product URLs or search-result URLs. Filter fields are ignored in this mode.", "default": [], "items": { "type": "string" } }, "fetchDetails": { "title": "Fetch full product details", "type": "boolean", "description": "Adds the full description, every image and video, variants, wholesale tiers, stock, sold and review counts, weight, condition and seller flags. Without it, runs already return name, price, image, rating, seller and category.", "default": false }, "maxPages": { "title": "Max pages per search", "minimum": 0, "type": "integer", "description": "Safety bound on result pages walked per keyword. Leave empty or 0 for unlimited. This does NOT cap the number of products; the run still stops at Max items." }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Maximum number of products to return across the whole run. The single finite cap. Set 0 for unlimited.", "default": 20 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Keep Apify Proxy enabled for the most complete results.", "default": { "useApifyProxy": true } }, "mcpConnectors": { "title": "Export to your apps (MCP)", "type": "array", "description": "Optional. Pick connected apps (Notion, Airtable, Linear, Apify) to also push each scraped product to, in addition to the dataset.", "default": [] }, "notionParentPageUrl": { "title": "Notion parent page URL", "type": "string", "description": "Optional. When a Notion connector is selected, create one page per product under this parent page." }, "maxNotifyItems": { "title": "Max items to export", "minimum": 0, "type": "integer", "description": "Optional cap on how many products are pushed to the selected MCP connectors." } } }, "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 } } } } } } } } } }