{ "openapi": "3.0.1", "info": { "title": "Rakuten Japan Products, Prices & Reviews Scraper", "description": "Search Rakuten Japan (Rakuten Ichiba) and collect products with prices, SKU options, stock, shop and rating data - plus customer reviews when you want them. No browser and no API key needed. Detail and review collection are optional, and you pay per result (pay-per-event).", "version": "0.1", "x-build-id": "g4n53jElYeSasmeOA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/huggable_quote~rakuten-japan-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-huggable_quote-rakuten-japan-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/huggable_quote~rakuten-japan-scraper/runs": { "post": { "operationId": "runs-sync-huggable_quote-rakuten-japan-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/huggable_quote~rakuten-japan-scraper/run-sync": { "post": { "operationId": "run-sync-huggable_quote-rakuten-japan-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 keywords", "type": "array", "description": "Japanese or English keywords to search, e.g. イヤホン. Each keyword is crawled separately and results are de-duplicated across all of them. Cost: about 1 request per result page (45 products per page).", "items": { "type": "string" } }, "searchUrls": { "title": "Search or category URLs", "type": "array", "description": "Rakuten search URLs you already have, e.g. https://search.rakuten.co.jp/search/mall/イヤホン/?s=2 . Filters you set in the URL are kept; any page number in it is ignored.", "items": { "type": "string" } }, "genreIds": { "title": "Genre (category) IDs", "type": "array", "description": "Rakuten genre IDs, e.g. 502835 for headphones. Each becomes its own category crawl.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Skip search and collect these Rakuten Ichiba product pages directly, e.g. https://item.rakuten.co.jp/// . These are charged as product detail ($0.0035 each) only - no search charge. Can be combined with the search inputs above.", "items": { "type": "string" } }, "maxItems": { "title": "Max products", "minimum": 0, "type": "integer", "description": "Stop after this many unique products across all searches. This is the main cost control: you are charged $0.0015 per stored search product, plus $0.0035 each if 'Include product detail' is on.", "default": 100 }, "maxPagesPerQuery": { "title": "Max pages per search", "minimum": 1, "maximum": 150, "type": "integer", "description": "How deep to page each keyword, URL or genre. One page returns up to 45 products. Rakuten only serves 150 pages per search, so higher values are capped.", "default": 5 }, "includeDetails": { "title": "Include product detail", "type": "boolean", "description": "Off by default (cheapest). When off, products carry only what the search results show and cost $0.0015 each. When on, each product costs $0.0035 more (so $0.0050 in total) and gains SKUs, stock, tax, point campaign, brand and description data.", "default": false }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Collect public reviews as separate records at $0.0015 each. Requires 'Include product detail'. Reviews are the largest cost driver: 100 products x 100 reviews is $15.", "default": false }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 0, "type": "integer", "description": "Upper bound on reviews per product, at $0.0015 per stored review. Rakuten returns 30 reviews per request.", "default": 100 }, "sort": { "title": "Sort order", "enum": [ "standard", "price_asc", "price_desc", "newest", "review_count", "review_average", "total_price_asc", "total_price_desc" ], "type": "string", "description": "Result order, matching the sort menu on Rakuten's own search page.", "default": "standard" }, "minPrice": { "title": "Minimum price (JPY)", "minimum": 0, "type": "integer", "description": "Only return products at or above this price." }, "maxPrice": { "title": "Maximum price (JPY)", "minimum": 0, "type": "integer", "description": "Only return products at or below this price." }, "includeSoldOut": { "title": "Include sold-out products", "type": "boolean", "description": "Rakuten hides sold-out products from search by default. Turn this on to include them.", "default": false }, "includeAds": { "title": "Include sponsored products", "type": "boolean", "description": "Rakuten shows up to five sponsored rows per search page. Keep them (default) to see the page as a shopper does, or switch this off to collect organic results only. A sponsored product that also ranks organically is always kept, with its organic rank. Excluded ads do not use up your 'Max products' budget and are never charged for.", "default": true }, "requestDelaySecs": { "title": "Delay between requests (seconds)", "minimum": 2, "type": "integer", "description": "Politeness delay. Values below 1.5s are raised to 1.5s, the pace validated against Rakuten without triggering blocks. Higher values make a run slower but gentler.", "default": 2 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 1, "type": "integer", "description": "Reserved for a future release. This version always runs sequentially (1).", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Disabled by default; the actor works from plain datacenter IPs, so leaving this off costs nothing.", "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 } } } } } } } } } }