{ "openapi": "3.0.1", "info": { "title": "ikyu.com Reviews Scraper (一休)", "description": "Scrape ikyu.com (一休) reviews for hotels and ryokan. Add hotel URLs, ids or names and get overall and six aspect ratings, title, full text, posting and stay dates, room, meals, party size, hotel reply, photos and likes, in English or Japanese. It can return only new reviews. $2.50 per 1,000 reviews.", "version": "1.0", "x-build-id": "sMJL1xFsb8yD6YIIg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/boncross~ikyu-reviews/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-boncross-ikyu-reviews", "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/boncross~ikyu-reviews/runs": { "post": { "operationId": "runs-sync-boncross-ikyu-reviews", "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/boncross~ikyu-reviews/run-sync": { "post": { "operationId": "run-sync-boncross-ikyu-reviews", "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": { "hotels": { "title": "Hotels", "type": "array", "description": "ikyu hotel URLs (https://www.ikyu.com/en-us/00000146/), 8-digit accommodation ids, or hotel names in English or Japanese.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (bulk upload)", "type": "array", "description": "ikyu page addresses, with the option to load them in bulk from a file, a Google Sheet or a remote list. Use this when you have more links than you want to paste. Combined with anything in the list above.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxReviewsPerHotel": { "title": "Max reviews per hotel", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Stop after this many reviews per hotel.", "default": 100 }, "maxItems": { "title": "Maximum results for the whole run", "minimum": 0, "type": "integer", "description": "A run-wide ceiling across every target. The per-target limit above applies to each one separately, so ten targets at 50 each returns 500; set this to cap the total. Zero means no run-wide limit. Rows that report an input the actor could not resolve are not counted here and are never charged for.", "default": 0 }, "sort": { "title": "Sort", "enum": [ "recent", "recommended" ], "type": "string", "description": "ikyu's orderings.", "default": "recent" }, "sources": { "title": "Review sources", "enum": [ "all", "ikyu" ], "type": "string", "description": "all = reviews from ikyu and its partner sites (Yahoo! Travel); ikyu = ikyu.com bookings only.", "default": "all" }, "minRating": { "title": "Minimum rating (0–5)", "minimum": 0, "maximum": 5, "type": "number", "description": "Drop reviews below this overall rating. 0 = off. Filtered reviews are free.", "default": 0 }, "maxRating": { "title": "Maximum rating (0–5)", "minimum": 0, "maximum": 5, "type": "number", "description": "Drop reviews above this. 0 = off.", "default": 0 }, "reviewedAfter": { "title": "Reviewed after", "type": "string", "description": "YYYY-MM-DD. Drop reviews posted before this (with Most recent sort, stops paging once older).", "default": "" }, "includeHotelSummary": { "title": "Hotel rating on every review", "type": "boolean", "description": "Overall rating, review count and rating by aspect (room, service, bath, facilities, meals, satisfaction) repeated on each row. No charge.", "default": true }, "includeAiSummary": { "title": "Include ikyu's AI review summary", "type": "boolean", "description": "ikyu's generated summary of what guests say (Japanese text), on each row. No charge.", "default": false }, "includeHotelDetails": { "title": "Include hotel details", "type": "boolean", "description": "Also return address, coordinates, check-in and check-out times, access, amenities, facilities, hot spring, parking and images. No extra charge.", "default": false }, "summaryOnly": { "title": "Summary rows only", "type": "boolean", "description": "Push one row per hotel with the aggregate ratings and no individual reviews (billed as hotel-summary).", "default": false }, "language": { "title": "Language", "enum": [ "en", "ja" ], "type": "string", "description": "en = ikyu's English translations of titles and texts; ja = Japanese originals.", "default": "en" }, "dedupStoreName": { "title": "Only-new store", "type": "string", "description": "Key-value store name. Reviews returned in earlier runs are skipped and not charged.", "default": "" }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 32, "type": "integer", "description": "How many requests run at once across the whole run. The default is the fastest level measured clean; lower it only if a run reports refusals or errors.", "default": 8 }, "delayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Optional pause before each call, in milliseconds. 0 (the default) runs as fast as the parallel limit allows.", "default": 0 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }