{ "openapi": "3.0.1", "info": { "title": "Jalan.net Area Rates Scraper (じゃらん)", "description": "Scrape Jalan (じゃらん) prices and rooms left for every available hotel in an area, a whole prefecture or a hotel list. Just add destinations or hotel IDs and a date or date range and get the lowest total, per-night and per-person price, rooms left, offer count and every bookable plan per date.", "version": "1.0", "x-build-id": "jHUGfytOmgN0ZCVKM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/boncross~jalan-area-rates/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-boncross-jalan-area-rates", "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-area-rates/runs": { "post": { "operationId": "runs-sync-boncross-jalan-area-rates", "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-area-rates/run-sync": { "post": { "operationId": "run-sync-boncross-jalan-area-rates", "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 (`Kyoto`, `北海道`), or a `Prefecture / Area` pair in English or Japanese (`Kyoto / Kyoto Station`, `Tokyo / Shinjuku`, `京都府 / 祇園・東山・北白川周辺`). Also Jalan area codes (`260000` a prefecture, `260500` an area, `260502` a sub-area) or a pasted jalan.net area URL. A whole prefecture is searched as one destination. An area name on its own is not enough: name the prefecture too. Leave empty when you only want the hotels below.", "items": { "type": "string" } }, "hotelIds": { "title": "Hotels", "type": "array", "description": "Jalan hotel numbers (`301552`) or hotel URLs (`https://www.jalan.net/yad301552/`). Each hotel gets a row for every date, including the dates it has nothing to sell (`isSoldOut: true`); a number Jalan does not know returns one error row. Use with or instead of destinations.", "default": [], "items": { "type": "string" } }, "outputMode": { "title": "Rows", "enum": [ "hotelDay", "offers" ], "type": "string", "description": "`hotelDay`: one row per hotel per check-in date, with the lowest total, rooms left and the number of offers. `offers`: one row per bookable offer (plan and room type) per hotel per date, each with its own prices and rooms left.", "default": "hotelDay" }, "maxItems": { "title": "Maximum results for the whole run", "minimum": 0, "type": "integer", "description": "A run-wide ceiling on rows (hotel-days or offers, whichever the run returns). Zero means no limit. Sold-out rows and rows for an input that could not be resolved are not counted and are never charged for.", "default": 0 }, "checkIn": { "title": "Check-in date", "type": "string", "description": "YYYY-MM-DD, for one check-in date. Leave empty and set the range below to price many dates, or leave both empty to use the days-ahead setting." }, "checkInFrom": { "title": "First check-in date", "type": "string", "description": "YYYY-MM-DD. Prices every check-in date from this one to the last check-in date below, inclusive. Up to a year ahead." }, "checkInTo": { "title": "Last check-in date", "type": "string", "description": "YYYY-MM-DD, inclusive. Defaults to the first check-in date." }, "checkInDaysAhead": { "title": "Check-in days ahead", "minimum": 0, "maximum": 365, "type": "integer", "description": "Used when no date is given: check in this many days from today (Japan time). Suits a scheduled run.", "default": 30 }, "nights": { "title": "Nights", "minimum": 1, "maximum": 9, "type": "integer", "description": "Length of each stay, 1-9 nights. A row's total covers every night.", "default": 1 }, "adults": { "title": "Adults per room", "minimum": 1, "maximum": 9, "type": "integer", "description": "1-9.", "default": 2 }, "rooms": { "title": "Rooms", "minimum": 1, "maximum": 10, "type": "integer", "description": "1-10 rooms, each with the adults above. Totals cover every room.", "default": 1 }, "childrenAges": { "title": "Children ages", "type": "array", "description": "Ages 0-12, in the first room. Jalan prices children 6 and over as 小学生 (primary school) and under 6 as 幼児 with meals and bedding.", "default": [] }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Only these kinds of property, as Jalan classifies them. 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": [] }, "mealType": { "title": "Meals", "enum": [ "any", "none", "breakfast", "dinner", "both" ], "type": "string", "description": "Keep only offers with this meal plan.", "default": "any" }, "facilities": { "title": "Facilities and room types", "type": "array", "description": "Jalan's こだわり filters. Every one chosen must apply.", "items": { "type": "string", "enum": [ "nonSmoking", "onsen", "openAirBath", "privateOpenAirBath", "largeBath", "highClass", "breakfastInRoom", "dinnerInRoom", "breakfastPrivateRoom", "dinnerPrivateRoom", "cardAccepted", "checkoutAfter11", "nearStation", "nearBeach", "pool", "sauna", "jacuzzi", "massage", "esthetic", "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", "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 (エステ)", "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": [] }, "minPricePerNight": { "title": "Min price per room per night (JPY)", "minimum": 0, "type": "integer", "description": "Keep only offers whose first-night price for one room is at least this. 0 = no floor.", "default": 0 }, "maxPricePerNight": { "title": "Max price per room per night (JPY)", "minimum": 0, "type": "integer", "description": "Keep only offers whose first-night price for one room is at most this. 0 = no limit.", "default": 0 }, "includeOffers": { "title": "Include every offer on hotel rows", "type": "boolean", "description": "With one row per hotel per date: add an `offers` list carrying every bookable plan and room type with its prices and rooms left.", "default": false }, "includePlanNames": { "title": "Include plan and room names", "type": "boolean", "description": "Fill `planName` and `roomName` (on hotel rows, the cheapest offer's). Adds one lookup per hotel per run, so it makes a run slower; names are null for a plan the lookup does not list.", "default": false }, "maxConcurrency": { "title": "Parallel searches", "minimum": 1, "maximum": 16, "type": "integer", "description": "How many searches run at once. A whole prefecture is always searched one date at a time. The default is the fastest level measured clean.", "default": 4 } } }, "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 } } } } } } } } } }