{ "openapi": "3.0.1", "info": { "title": "Jalan.net Scraper — Japan Hotels & Ryokan Prices", "description": "Jalan scraper for Japan hotel prices: hotels & ryokan with advertised prices, plans and ratings from jalan.net by prefecture and area — clean English schema for Japan hotel rate shopping. Unofficial; not affiliated with Recruit Co., Ltd.", "version": "0.1", "x-build-id": "KmnATh6iz8vBHGjEd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jpopendata~japan-hotels-jalan/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jpopendata-japan-hotels-jalan", "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/jpopendata~japan-hotels-jalan/runs": { "post": { "operationId": "runs-sync-jpopendata-japan-hotels-jalan", "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/jpopendata~japan-hotels-jalan/run-sync": { "post": { "operationId": "run-sync-jpopendata-japan-hotels-jalan", "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": [ "prefecture" ], "properties": { "prefecture": { "title": "Prefecture", "enum": [ "Hokkaido", "Aomori", "Iwate", "Miyagi", "Akita", "Yamagata", "Fukushima", "Ibaraki", "Tochigi", "Gunma", "Saitama", "Chiba", "Tokyo", "Kanagawa", "Niigata", "Toyama", "Ishikawa", "Fukui", "Yamanashi", "Nagano", "Gifu", "Shizuoka", "Aichi", "Mie", "Shiga", "Kyoto", "Osaka", "Hyogo", "Nara", "Wakayama", "Tottori", "Shimane", "Okayama", "Hiroshima", "Yamaguchi", "Tokushima", "Kagawa", "Ehime", "Kochi", "Fukuoka", "Saga", "Nagasaki", "Kumamoto", "Oita", "Miyazaki", "Kagoshima", "Okinawa" ], "type": "string", "description": "REQUIRED. Choose one of the 47 prefectures by its English name (e.g. \"Tokyo\", \"Osaka\", \"Kyoto\"). Via API/CLI pass the English name exactly as listed (e.g. \"Tokyo\", not \"東京都\" / \"13\" / \"tokyo-to\" — the platform validates the list before the run starts and rejects anything else with the list of valid values). Cities are NOT prefectures: use \"Kanagawa\" for Yokohama, \"Aichi\" for Nagoya, \"Osaka\" for Osaka-shi. jalan.net hotel lists are prefecture-scoped; narrow further with area / keyword.", "default": "Kyoto" }, "area": { "title": "Area within the prefecture", "type": "string", "description": "Optional. Leave empty to search ALL areas of the prefecture (recommended for a first run). To narrow: a jalan LRG area code (\"260500\" or \"LRG_260500\", from jalan.net URLs) or a substring of the JAPANESE area name (e.g. \"京都駅\" matches 京都駅周辺; romaji such as \"Arashiyama\" matches nothing). If the value matches none of the prefecture's areas the run stops after the hub page with the full list of valid areas. Do NOT put a prefecture name here." }, "keyword": { "title": "Hotel name keyword", "type": "string", "description": "Optional. Case-insensitive substring filter on the facility name (Japanese or English), applied client-side after fetching — a rare keyword may need a higher maxApiRequests to fill maxItems." }, "checkin": { "title": "Check-in date (optional)", "type": "string", "description": "Optional. ISO date YYYY-MM-DD (e.g. \"2026-10-01\"), today or later. When set, prices reflect availability for this stay (with nights/guests). When empty, the actor returns each facility's lowest advertised prices (undated) — the simplest, always-available mode." }, "nights": { "title": "Nights", "minimum": 1, "maximum": 30, "type": "integer", "description": "Optional, default 1. Number of nights (1..30, only meaningful with checkin).", "default": 1 }, "guests": { "title": "Guests (adults)", "minimum": 1, "maximum": 10, "type": "integer", "description": "Optional, default 2. Number of adult guests per room (1..10, only meaningful with checkin).", "default": 2 }, "includeDetails": { "title": "Fetch facility detail pages", "type": "boolean", "description": "Optional, default true. When true, each facility costs one extra request but includes full address, postal code, room count, check-in/out times, onsen flag and amenity list. When false the actor emits list data only (name, area, rating, review count, prices, plans) — cheaper.", "default": true }, "maxItems": { "title": "Max records", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Optional, default 10. Stop after this many facility records (1..10000). Each list page yields up to 30 facilities; with includeDetails each record also needs one detail request, so raise maxApiRequests accordingly.", "default": 10 }, "maxApiRequests": { "title": "Max upstream requests", "minimum": 1, "maximum": 60, "type": "integer", "description": "Optional, default 30. Hard budget of HTTP requests to jalan.net for this run (1 hub page + list pages of 30 facilities + 1 per facility detail). Requests are strictly serial with >= 1.2 s spacing. When the budget runs out the run still SUCCEEDS with the records collected so far and complete=false in RUN_SUMMARY (not an error).", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Apify proxy settings. Default: no proxy (direct connection). Never used for rotation/evasion — one client identity per run (a single sticky egress IP for the whole run). Set only if jalan.net starts refusing the runtime IP (HTTP 403)." } } }, "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 } } } } } } } } } }