{ "openapi": "3.0.1", "info": { "title": "SUUMO Scraper — Japan Property Data & API", "description": "SUUMO scraper & real estate data API for Japan's #1 property portal. Rent & sale listings: price, layout, area, floor, deposit, key money, building age, station access, photos — clean JSON/CSV, one row per room. No SUUMO account needed. SUUMO（スーモ）の賃貸・売買の物件データを取得。", "version": "1.0", "x-build-id": "R0xWk8QdmdvZ5WpU4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~suumo-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-suumo-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~suumo-property-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-suumo-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~suumo-property-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-suumo-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** — fast, cheap. Pulls a full record per listing straight from the SUUMO search page (price, deposit, key money, layout, area, station, photos).\n\n🔍 **DETAIL** — same record plus full structured specs for each listing (structure, direction, parking, contract terms, move-in date). Slower and priced higher per result.\n\n**TIP:** Start with Overview — the search page already carries most fields. Use Detail only when you need the full spec table.", "default": "overview" }, "searchMode": { "title": "🧭 Search by", "enum": [ "byPlace", "bySearchUrl", "byListingUrl" ], "type": "string", "description": "🧭 How to tell the scraper what to fetch:\n\n- **By prefecture** — pick a section (rent/sale) and a prefecture (e.g. Tokyo, Osaka).\n- **By search URL** — paste a SUUMO search-results URL; all filters in the URL are honored.\n- **By listing URL** — Detail mode only: paste SUUMO listing URLs to fetch specific properties.", "default": "byPlace" }, "section": { "title": "🏠 Section", "enum": [ "rent", "used_mansion", "used_house", "new_house", "new_mansion" ], "type": "string", "description": "🏠 Property vertical. **Rent** (賃貸) is the primary section with full coverage. Sale sections (used/new mansion, used/new house) use a different card markup — rent is recommended for best results.", "default": "rent" }, "prefecture": { "title": "🗺️ Prefecture", "type": "string", "description": "🗺️ Japanese prefecture name (e.g. `tokyo`, `osaka`, `kyoto`, `kanagawa`) or a 2-digit SUUMO code (`13` = Tokyo). Used with **By prefecture** mode.", "default": "tokyo" }, "searchUrls": { "title": "🔗 Search URLs", "type": "array", "description": "🔗 SUUMO search-results URLs to scrape. Used when **Search by = By search URL**.\n\n**TIP:** Build any search on suumo.jp (set area, filters, sort), then copy the URL from the address bar — all query filters are preserved.\n\n**BULK EDIT:** Click \"Bulk edit\" to paste many URLs, one per line.", "items": { "type": "string" } }, "listingUrls": { "title": "🆔 Listing URLs", "type": "array", "description": "🆔 **Detail mode only.** SUUMO listing URLs (e.g. https://suumo.jp/chintai/bc_100512520556/).\n\n**BULK EDIT:** Click \"Bulk edit\" to paste many URLs, one per line.", "items": { "type": "string" } }, "filters": { "title": "🔧 Extra SUUMO filters", "type": "object", "description": "🔧 Optional extra SUUMO query params (key-value). e.g. `{\"cb\": \"8.0\", \"md\": \"4\"}` for max ¥80k rent, 4+ rooms. See SUUMO URL params for available keys.", "default": {} }, "maxResults": { "title": "🔢 Max results", "minimum": 1, "type": "integer", "description": "🔢 Maximum listings to extract this run.\n\n- **FREE tier:** capped at 25 listings per run.\n- **PAID tier:** unlimited — set as high as you need.", "default": 100 } } }, "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 } } } } } } } } } }