{
"openapi": "3.0.1",
"info": {
"title": "Japan Hotel Rates - Rakuten Travel, Jalan, Ikyu, Yahoo",
"description": "Scrape Japanese hotel prices from Rakuten Travel, Jalan, Ikyu and Yahoo! Travel: every room type and rate plan for a stay, with tax-inclusive JPY totals, meals, cancellation terms and member prices. Find hotel numbers by name. Batch many hotels. Made by ScraperCompany.",
"version": "1.0",
"x-build-id": "sZ8MjROiawa5qCNkh"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/scrapercompany~japan-hotel-rates-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-scrapercompany-japan-hotel-rates-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/scrapercompany~japan-hotel-rates-scraper/runs": {
"post": {
"operationId": "runs-sync-scrapercompany-japan-hotel-rates-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/scrapercompany~japan-hotel-rates-scraper/run-sync": {
"post": {
"operationId": "run-sync-scrapercompany-japan-hotel-rates-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": {
"mode": {
"title": "Site and task",
"enum": [
"rakuten",
"jalan",
"ikyu",
"yahoo_travel",
"rakuten_find",
"jalan_find",
"ikyu_find",
"yahoo_travel_find"
],
"type": "string",
"description": "Which site to read and whether to price stays or look up hotel numbers by name.",
"default": "rakuten"
},
"hotels": {
"title": "Hotels",
"type": "array",
"description": "One hotel per line. For rooms and prices: the site's hotel number (Rakuten 74637 from travel.rakuten.co.jp/HOTEL/74637/, Jalan 389255 from jalan.net/yad389255/, Ikyu and Yahoo! Travel 00000065 from ikyu.com/00000065/). For find hotel numbers: a hotel name in Japanese or English.",
"default": [
"74637"
],
"items": {
"type": "string"
}
},
"check_in": {
"title": "Check-in",
"pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$",
"type": "string",
"description": "Exact (2026-12-01) or relative (30 days from today).",
"default": "30 days"
},
"nights": {
"title": "Nights",
"minimum": 1,
"maximum": 14,
"type": "integer",
"description": "Length of stay (1-14).",
"default": 1
},
"adults": {
"title": "Adults",
"minimum": 1,
"maximum": 9,
"type": "integer",
"description": "Guests in the room (1-9).",
"default": 2
},
"city": {
"title": "City",
"type": "string",
"description": "Optional city or prefecture to narrow a name lookup (e.g. 東京 or Kyoto)."
},
"limit": {
"title": "Matches per name",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "How many candidate hotels to return for each name (1-10).",
"default": 5
},
"customRequests": {
"title": "Custom requests (advanced)",
"type": "array",
"description": "Optional list of JSON objects, one request each, using the field names shown above. Each object is merged over the options above, so you only need to give what differs. Use \"mode\" (rakuten, jalan, ikyu, yahoo_travel, or the same with _find) to pick the site per object. Example: {\"mode\":\"jalan\",\"hotel_no\":\"389255\",\"check_in\":\"2026-12-20\",\"nights\":2,\"adults\":2}"
},
"includeErrors": {
"title": "Include failed requests in the dataset",
"type": "boolean",
"description": "When on, a request that fails (for example an unknown property id) is saved as a dataset item with an error message so you can see what went wrong. Failed requests are never charged.",
"default": true
},
"maxConcurrency": {
"title": "Parallel requests",
"minimum": 1,
"maximum": 8,
"type": "integer",
"description": "How many requests run at the same time (1-8). Parallel runs share one limit, so extra requests wait for a free slot instead of failing.",
"default": 3
},
"maxRetries": {
"title": "Retries per request",
"minimum": 0,
"maximum": 5,
"type": "integer",
"description": "How many times a request that failed for a temporary reason is tried again. Invalid input is never retried.",
"default": 2
}
}
},
"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
}
}
}
}
}
}
}
}
}
}