{ "openapi": "3.0.1", "info": { "title": "Yahoo!不動産 Scraper — Japan Property Data & API", "description": "Yahoo!不動産 (Yahoo Real Estate) scraper & data API for one of Japan's largest property portals. Rent & sale listings: price, layout, area, floor, deposit, key money, building age, structure, station access, photos — clean JSON/CSV, one row per room. Fast overview or full detail. No account needed.", "version": "1.0", "x-build-id": "exHFNg3eCr5AL8bnH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~yahoo-realestate-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-yahoo-realestate-property-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/sian.agency~yahoo-realestate-property-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-yahoo-realestate-property-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/sian.agency~yahoo-realestate-property-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-yahoo-realestate-property-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": { "scrapeMode": { "title": "🧭 Scrape mode", "enum": [ "overview", "detail" ], "type": "string", "description": "🧭 **OVERVIEW** (cheap, primary): room-level cards from the search results — one row per rentable unit, with price, layout, area, floor, deposit, key money, station access & cover photo.\n\n🔎 **DETAIL** (enrich): fetches each listing's full page for the complete spec table — structure, building age, aspect, facilities (bath, kitchen, balcony, security), address, full image set. Detail merges overview + detail into one record.", "default": "overview" }, "searchMode": { "title": "🔀 Search mode", "enum": [ "byPlace", "bySearchUrl", "byListingUrl" ], "type": "string", "description": "🔀 How listings are discovered.\n\n- **byPlace** — give one or more prefectures (JIS code like `13`, or a name like `Tokyo` / `東京都`) + a vertical.\n- **bySearchUrl** — paste a ready-made Yahoo!不動産 search URL with your filters applied in the UI (most reliable).\n- **byListingUrl** — fetch specific listings directly (DETAIL only).", "default": "byPlace" }, "vertical": { "title": "🏘️ Vertical", "enum": [ "rent", "buy", "chukomansion", "chukoikkodate", "shinchikuikkodate", "tochi" ], "type": "string", "description": "🏘️ Which Yahoo!不動産 vertical to scrape.\n\n- **rent** (賃貸) — fully supported; explodes each building into one row per room.\n- **buy / chukomansion / chukoikkodate / shinchikuikkodate / tochi** — sale verticals (use `rent` for the richest per-room data).", "default": "rent" }, "places": { "title": "📍 Prefectures", "type": "array", "description": "📍 **BY PREFECTURE:** Prefectures to scrape — JIS code (`13`), English name (`Tokyo`) or Japanese (`東京都`). Common codes: `13` Tokyo, `27` Osaka, `14` Kanagawa, `23` Aichi, `40` Fukuoka.\n\n💡 **TIP:** For precise filtering, use **bySearchUrl** instead — apply your filters in Yahoo!不動産's UI and paste the URL.", "default": [ "13" ], "items": { "type": "string" } }, "searchUrls": { "title": "🔗 Search URLs", "type": "array", "description": "🔗 **BY SEARCH URL:** Paste one or more Yahoo!不動産 search-results URLs. Apply all your filters in the UI first, then copy the address — every supported filter is preserved.", "items": { "type": "string" } }, "listingUrls": { "title": "🏠 Listing URLs", "type": "array", "description": "🏠 **BY LISTING URL (DETAIL ONLY):** Paste Yahoo!不動産 detail URLs (e.g. `https://realestate.yahoo.co.jp/rent/detail/000008893370004f89.../`) or bare room ids. Used with scrapeMode = detail.", "items": { "type": "string" } }, "filters": { "title": "🎛️ Extra filters", "type": "array", "description": "🎛️ **OPTIONAL:** Extra Yahoo!不動産 query filters as `key=value`, applied to byPlace searches. Examples: `sort=14` (sort order), `walk=10` (max station walk minutes), `madori=...` (layout). Copy the exact key=value pairs from a Yahoo!不動産 search URL.", "items": { "type": "string" } }, "maxResults": { "title": "🔢 Max results", "minimum": 1, "type": "integer", "description": "🔢 Maximum listings to return per run. **FREE users:** capped at 25 · **PAID users:** unlimited.", "default": 100 }, "useProxy": { "title": "🌐 Use Japan residential proxy", "type": "boolean", "description": "🌐 Route requests through a Japan residential proxy. **Off by default** — Yahoo!不動産 is reachable without a proxy, so leaving this off keeps runs fast and cheap. Enable only if you hit a geo-block or rate-limit.", "default": false } } }, "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 } } } } } } } } } }