{ "openapi": "3.0.1", "info": { "title": "Rakuten Japan Listings Scraper", "description": "The Rakuten Japan Listings Scraper extracts product listings from Rakuten — capturing names, JPY prices, review scores, shop info, shipping, Rakuten points, structured tags, and category breadcrumbs — ideal for Japanese marketplace research, price monitoring, and catalog building.", "version": "0.1", "x-build-id": "MBHTBjgkxlTBPa7Kn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/piotrv1001~rakuten-japan-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-piotrv1001-rakuten-japan-listings-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/piotrv1001~rakuten-japan-listings-scraper/runs": { "post": { "operationId": "runs-sync-piotrv1001-rakuten-japan-listings-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/piotrv1001~rakuten-japan-listings-scraper/run-sync": { "post": { "operationId": "run-sync-piotrv1001-rakuten-japan-listings-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": "List of keyword searches to crawl. Each entry is an object with 'keyword' (required), optional 'genreId' (Rakuten genre id, e.g. '560202' for smartphones), optional 'sort' ('default' | 'price-asc' | 'price-desc' | 'review'), and optional 'pages' (max search-result pages to crawl, capped at 150).", "default": [] }, "genreIds": { "title": "Genre IDs (browse without keyword)", "type": "array", "description": "Rakuten genre IDs to browse without a keyword. Each genre maps to a category page like https://search.rakuten.co.jp/search/mall//{genreId}/.", "default": [], "items": { "type": "string" } }, "shopUrlCodes": { "title": "Shop URL codes", "type": "array", "description": "Rakuten shop URL codes (the slug after item.rakuten.co.jp/, e.g. 'rakutenmobile-store'). Browses the shop's full catalog at https://search.rakuten.co.jp/search/inshop/{shopUrlCode}/.", "default": [], "items": { "type": "string" } }, "pdpUrls": { "title": "Product page URLs", "type": "array", "description": "Direct product detail page URLs in the form https://item.rakuten.co.jp/{shopUrlCode}/{itemCode}/. Each URL is fetched and parsed for og: tags, microdata price/availability, and breadcrumb.", "default": [], "items": { "type": "string" } }, "includeDetails": { "title": "Include product detail data", "type": "boolean", "description": "If enabled, every item found via search is followed to its product detail page (PDP) for additional fields (description, og:image, breadcrumbs, microdata price/availability). When enabled, each product is billed for both the 'product-listing' and 'item-detail' Pay-Per-Event charges. When disabled, only 'product-listing' is billed per product.", "default": false }, "appKey": { "title": "Rakuten Webservice applicationId (optional)", "type": "string", "description": "Optional Rakuten Webservice applicationId. When provided, the actor switches to the official IchibaItem/Search REST API instead of HTML scraping. Caps at 30 items × 100 pages = 3,000 items per query." }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Global cap on the total number of products pushed to the dataset for this run, summed across all queries / genres / shops / direct PDPs. Useful to keep Pay-Per-Event spend predictable on broad searches (Rakuten can return up to ~6,750 items per keyword).", "default": 1000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Defaults to Apify Residential Proxy when running on the Apify platform — Rakuten's Akamai edge will 403 most datacenter IPs. Switch to DATACENTER for cheaper bandwidth if your testing shows it works for your queries, or disable proxy entirely for local development.", "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 } } }, "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 } } } } } } } } } }