{ "openapi": "3.0.1", "info": { "title": "Jalan.net Hotel Search Scraper (じゃらん)", "description": "Scrape Jalan (じゃらん) hotel search results for any area and your dates. Just add area names in English or Japanese and get cheapest plan total and per-person price, rating, review count, inline plans with rooms left, meals and prepaid flags, with Jalan's own facility filters. $1.50 per 1,000 hotels.", "version": "1.0", "x-build-id": "vQ803fTyUvmFBGNad" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/boncross~jalan-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-boncross-jalan-search", "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~jalan-search/runs": { "post": { "operationId": "runs-sync-boncross-jalan-search", "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~jalan-search/run-sync": { "post": { "operationId": "run-sync-boncross-jalan-search", "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": { "destinations": { "title": "Destinations", "type": "array", "description": "A prefecture on its own, or a `Prefecture / Area` pair, in English or Japanese (`Kyoto`, `Kyoto / Kyoto Station`, `京都府 / 祇園・東山・北白川周辺`, `Tokyo / Shinjuku`). Also Jalan area codes (`260000` prefecture, `260500` large area) or pasted jalan.net search URLs. An area name on its own (`Shinjuku`) is not enough: Jalan nests areas under prefectures, so name the prefecture too.", "default": [ "Kyoto / Kyoto Station" ], "items": { "type": "string" } }, "keyword": { "title": "Keyword", "type": "string", "description": "Keep only hotels whose own text carries every term you give: the name, catchphrase, description, access notes, area, labels and the plans on the card. Leave empty for the whole area.", "default": "" }, "maxResultsPerDestination": { "title": "Max hotels per destination", "minimum": 1, "maximum": 3000, "type": "integer", "description": "Jalan returns 30 hotels per page.", "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 }, "checkIn": { "title": "Check-in date", "type": "string", "description": "YYYY-MM-DD. Defaults to `checkinDaysAhead` days from today. Lowercase `checkin` also works." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "YYYY-MM-DD. Defaults to check-in + `nights`. Lowercase `checkout` also works." }, "checkInDaysAhead": { "title": "Check-in days ahead", "minimum": 0, "maximum": 365, "type": "integer", "description": "Used when `checkin` is empty. Lowercase `checkinDaysAhead` also works.", "default": 30 }, "nights": { "title": "Nights", "minimum": 1, "maximum": 9, "type": "integer", "description": "1–9 (Jalan's maximum). Used when `checkout` is empty.", "default": 1 }, "adults": { "title": "Adults per room", "minimum": 1, "maximum": 9, "type": "integer", "description": "1–9.", "default": 2 }, "childrenAges": { "title": "Children ages", "type": "array", "description": "Ages 0–12. Jalan buckets children as 小学生 (6–11) and 幼児 (under 6, with meals and bedding).", "default": [] }, "rooms": { "title": "Rooms", "minimum": 1, "maximum": 10, "type": "integer", "description": "1–10.", "default": 1 }, "dateUndecided": { "title": "Date undecided", "type": "boolean", "description": "Search without dates: Jalan then shows each hotel's lowest catalogue price instead of dated availability.", "default": false }, "sort": { "title": "Sort", "enum": [ "recommended", "price_low_to_high", "price_high_to_low", "area" ], "type": "string", "description": "Jalan's own orderings.", "default": "recommended" }, "mealType": { "title": "Meal type", "enum": [ "any", "none", "breakfast", "dinner", "both" ], "type": "string", "description": "Keep only hotels with a plan that includes this meal arrangement, as Jalan's own search filters them.", "default": "any" }, "minPricePerPerson": { "title": "Min price per person (JPY)", "minimum": 0, "type": "integer", "description": "Per adult per night. Asked of Jalan and also enforced on the results, because Jalan honours only its own price bands.", "default": 0 }, "maxPricePerPerson": { "title": "Max price per person (JPY)", "minimum": 0, "type": "integer", "description": "Per adult per night, checked against each hotel's listed price. 0 = no limit.", "default": 0 }, "facilities": { "title": "Facility filters", "type": "array", "description": "Jalan's own facility filters (こだわり), applied by the site. Several combine: a hotel must have all of them.", "items": { "type": "string", "enum": [ "nonSmoking", "onsen", "openAirBath", "privateOpenAirBath", "largeBath", "highClass", "breakfastInRoom", "dinnerInRoom", "breakfastPrivateRoom", "dinnerPrivateRoom", "cardAccepted", "onlineCardOnly", "checkoutAfter11", "nearStation", "nearBeach", "pool", "sauna", "jacuzzi", "massage", "esthetic", "pets", "shuttle", "parking", "lookoutBath", "freeFlowingOnsen", "cloudyOnsen", "roomSingle", "roomTwin", "roomDouble", "roomTriple", "roomFourBeds", "roomJapanese", "roomJapaneseWestern", "privateBathRental", "suiteOrDetached", "internetInRoom", "skiRental", "snowboardRental", "tableTennis" ], "enumTitles": [ "Non-smoking rooms (禁煙ルーム)", "Hot spring (温泉)", "Open-air bath (露天風呂)", "Room with open-air bath (露天風呂付き客室)", "Large shared bath (大浴場)", "Jalan high class (ハイクラス)", "Breakfast in the room", "Dinner in the room", "Breakfast in a private dining room", "Dinner in a private dining room", "Card payment accepted", "Online card payment (オンラインカード決済)", "Check-out 11:00 or later", "Within 5 minutes' walk of a station", "Within 5 minutes' walk of a beach", "Outdoor pool", "Sauna", "Jacuzzi", "Massage", "Beauty treatments (エステ)", "Pets allowed (ペット可)", "Pick-up service (送迎)", "Free parking", "View bath (展望風呂)", "Free-flowing hot spring (掛け流し)", "Cloudy hot spring (にごり湯)", "Single rooms", "Twin rooms", "Double rooms", "Triple rooms", "Four-bed rooms", "Japanese-style rooms (和室)", "Japanese-Western rooms (和洋室)", "Private bath for hire (貸切風呂)", "Suite, special room or detached room", "Internet in the room", "Ski rental", "Snowboard rental", "Table tennis" ] }, "default": [] }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Only these kinds of property, as Jalan classifies them (ホテル, 旅館, ペンション・民宿・ロッジ, 公共の宿, 貸別荘・コンドミニアム). Each result carries its type in `propertyType`. Leave empty for every kind.", "items": { "type": "string", "enum": [ "hotel", "ryokan", "pension", "publicLodging", "villa" ], "enumTitles": [ "Hotel / business hotel (ホテル)", "Ryokan (旅館)", "Pension, minshuku, lodge (ペンション・民宿・ロッジ)", "Public lodging (公共の宿)", "Villa / condominium (貸別荘)" ] }, "default": [] }, "minRating": { "title": "Min rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Drop hotels rated below this (0–5, Jalan's 5-point クチコミ scale; hotels without a rating are dropped when set). Post-filter, free. Ratings are decimal, so 4.5 is a valid bound.", "default": 0 }, "minReviewCount": { "title": "Min review count", "minimum": 0, "type": "integer", "description": "Post-filter, free.", "default": 0 }, "highClassOnly": { "title": "High class only", "type": "boolean", "description": "Keep only hotels Jalan labels ハイクラス.", "default": false }, "excludeSponsored": { "title": "Exclude sponsored", "type": "boolean", "description": "Drop the PR (advertised) cards.", "default": false }, "includePlans": { "title": "Include inline plans", "type": "boolean", "description": "Keep the up-to-3 plan rows Jalan shows on each result card (plan title, room type, per-person and total price, rooms left).", "default": true }, "includeHotelDetails": { "title": "Include hotel details", "type": "boolean", "description": "Add each hotel's map coordinates (lat, lng), check-in and check-out times, kana name, accepted card brands and total number of plans to its row.", "default": true }, "priceStoreName": { "title": "Price store name", "type": "string", "description": "Named key-value store remembering each hotel's lowest total per stay, so `previousPriceTotal` and `priceChange` are filled on later runs.", "default": "" }, "onlyNewOrChanged": { "title": "Only new or changed", "type": "boolean", "description": "With a price store: skip hotels whose lowest total is unchanged since the last run.", "default": false }, "delayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Optional pause before each call, in milliseconds. 0 (the default) runs as fast as the parallel limit allows.", "default": 0 }, "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": 16 } } }, "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 } } } } } } } } } }