{ "openapi": "3.0.1", "info": { "title": "Rakuten Ichiba Japan Product & Price Scraper", "description": "Search Rakuten Ichiba, Japan's largest marketplace. Filter by keyword, genre, shop and price, then export item name, price (JPY), item code, shop, review count & average, availability, points, genre and images. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "FBY89rWefEIjZUOyX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~rakuten-japan-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-rakuten-japan-products-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/scrapers_lat~rakuten-japan-products-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-rakuten-japan-products-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/scrapers_lat~rakuten-japan-products-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-rakuten-japan-products-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": "One or more keywords to search Rakuten Ichiba for (Japanese or English, e.g. 'coffee', 'ワイヤレスイヤホン'). Each keyword runs its own search, so add several to collect more products in one run.", "items": { "type": "string" } }, "genreId": { "title": "Genre ID (optional)", "type": "string", "description": "Optional. Restrict results to one Rakuten genre by its numeric genre ID (e.g. '100227' for food)." }, "shopCode": { "title": "Shop code (optional)", "type": "string", "description": "Optional. Restrict results to a single Rakuten shop by its shop code." }, "minPrice": { "title": "Minimum price (JPY, optional)", "minimum": 0, "type": "integer", "description": "Optional. Only return items priced at or above this amount in Japanese yen." }, "maxPrice": { "title": "Maximum price (JPY, optional)", "minimum": 0, "type": "integer", "description": "Optional. Only return items priced at or below this amount in Japanese yen." }, "availableOnly": { "title": "In-stock only", "type": "boolean", "description": "Only return items that are currently available to purchase.", "default": false }, "sort": { "title": "Sort by", "enum": [ "standard", "priceAsc", "priceDesc", "reviewCount", "reviewAverage", "newest" ], "type": "string", "description": "Order the results by relevance, price, review count, review score, or newest.", "default": "standard" }, "minReviewCount": { "title": "Minimum review count (optional)", "minimum": 0, "type": "integer", "description": "Optional. Only keep items with at least this many reviews." }, "minReviewAverage": { "title": "Minimum review score (optional)", "minimum": 0, "maximum": 5, "type": "number", "description": "Optional. Only keep items with an average review score at or above this value (0 to 5)." }, "applicationId": { "title": "Rakuten application ID", "type": "string", "description": "Your free Rakuten Web Service applicationId. Register a free app in minutes at webservice.rakuten.co.jp, then paste the application ID here." }, "maxProducts": { "title": "Max Products To Scrape", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of product records to collect across the whole run." } } }, "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 } } } } } } } } } }