{ "openapi": "3.0.1", "info": { "title": "Ikyu Hotel Rate Scraper", "description": "Captures ikyu.com selling prices, points, and effective (points-applied) prices for every room x plan x future check-in date at any hotel/ryokan, including sold-out dates.", "version": "0.1", "x-build-id": "WGCH15GkSZqhmDtXc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cobocus~ikyu-hotel-rate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cobocus-ikyu-hotel-rate-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/cobocus~ikyu-hotel-rate-scraper/runs": { "post": { "operationId": "runs-sync-cobocus-ikyu-hotel-rate-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/cobocus~ikyu-hotel-rate-scraper/run-sync": { "post": { "operationId": "run-sync-cobocus-ikyu-hotel-rate-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": [ "propertyUrls" ], "properties": { "propertyUrls": { "title": "Property URLs", "type": "array", "description": "One or more ikyu.com property URLs, e.g. https://www.ikyu.com/00002130/. Any number of properties is supported.", "items": { "type": "string" } }, "monthsAhead": { "title": "Months ahead", "minimum": 1, "maximum": 18, "type": "integer", "description": "Scan every day from today through this many months ahead. Ignored if both Start date and End date are set. Run this Actor daily to build a rolling 'today + N months' time series.", "default": 6 }, "startDate": { "title": "Start date (advanced)", "type": "string", "description": "Advanced: explicit range start, YYYY-MM-DD. Leave empty to start from today (recommended for daily monitoring)." }, "endDate": { "title": "End date (advanced)", "type": "string", "description": "Advanced: explicit range end, YYYY-MM-DD, inclusive. Leave empty to use Start date + Months ahead." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of adult guests per room.", "default": 2 }, "children": { "title": "Children", "minimum": 0, "maximum": 10, "type": "integer", "description": "Number of children per room. Mapped to ikyu's default child age-band (elementary-school age, with meal & bed); see README for details.", "default": 0 }, "rooms": { "title": "Rooms", "minimum": 1, "maximum": 5, "type": "integer", "description": "Number of rooms to search for per booking.", "default": 1 }, "includeSoldOut": { "title": "Include sold-out dates", "type": "boolean", "description": "Keep rows for dates/rooms with no bookable plan. Recommended ON: knowing when a hotel sells out is itself valuable rate data.", "default": true }, "datesPerRequest": { "title": "Dates per request (advanced)", "minimum": 1, "maximum": 18, "type": "integer", "description": "How many check-in dates to batch into a single GraphQL request. ikyu's API enforces a query complexity limit that this Actor's field selection hits at ~19-20 dates/request, so 18 is the hard maximum; 15 is the default and leaves some headroom.", "default": 15 }, "maxConcurrency": { "title": "Max concurrency (advanced)", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of batched requests in flight at once, across all properties. Capped at 10; this Actor only needs around a dozen requests per property, and a live production site should not be hit harder than that.", "default": 5 }, "runSummaryDatasetName": { "title": "Run summary dataset name", "type": "string", "description": "Optional. Name of a dataset to append this run's summary to, as a single row per run. Useful on a schedule: consecutive daily runs build one small table you can read at a glance to confirm each run collected every date, instead of aggregating tens of thousands of rate rows. Named datasets are retained indefinitely. The summary is always written to this run's key-value store as OUTPUT regardless of this setting." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Defaults to Apify Proxy on the Japanese RESIDENTIAL group, which is effectively required: ikyu.com blocks Apify datacenter IPs. Measured A/B over a 182-day scan - US datacenter proxy returned 22 HTTP 403s and silently lost 15 dates; JP residential returned none and collected all 182. Residential is billed per GB, but this Actor moves only ~1 MB per run. Override only if you have a reason to.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "JP" } } } }, "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 } } } } } } } } } }