{ "openapi": "3.0.1", "info": { "title": "Japan Real Estate (suumo.jp)", "description": "Japanese rental & for-sale property listings from suumo.jp — rent/sale price, layout, floor area, building age, stations and per-m²/tsubo analytics by prefecture/city, English schema, privacy-safe addresses. Unofficial; not affiliated with Recruit Co., Ltd.", "version": "0.1", "x-build-id": "T2ohn7SkwGSEsmnh3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jpopendata~japan-real-estate-suumo/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jpopendata-japan-real-estate-suumo", "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-real-estate-suumo/runs": { "post": { "operationId": "runs-sync-jpopendata-japan-real-estate-suumo", "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-real-estate-suumo/run-sync": { "post": { "operationId": "run-sync-jpopendata-japan-real-estate-suumo", "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": { "mode": { "title": "Listing type", "enum": [ "rent", "buy_mansion", "buy_house", "buy_land" ], "type": "string", "description": "What to search: \"rent\" (賃貸 rental units), \"buy_mansion\" (中古マンション used condos), \"buy_house\" (中古一戸建て used houses) or \"buy_land\" (土地 land lots).", "default": "rent" }, "prefecture": { "title": "Prefecture", "type": "string", "description": "REQUIRED. Prefecture to search: JIS code (\"13\"), Japanese (\"東京都\") or English (\"Tokyo\"). suumo.jp static list pages are prefecture-scoped.", "default": "Tokyo" }, "area": { "title": "City / ward (optional)", "type": "string", "description": "Optional city scope: Japanese name (\"新宿区\", \"横浜市西区\"), romaji (\"shinjuku\") or a raw suumo slug (\"sc_shinjuku\"). Resolved against the prefecture's live city index; an unknown value fails loudly listing all valid cities. Leave empty to crawl all cities of the prefecture in order." }, "priceMin": { "title": "Min price (rent: JPY/month, buy: 万円)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional lower price bound, applied client-side. UNIT SWITCHES BY MODE: for mode=rent this is JPY per month (e.g. 50000 = ¥50,000/month); for buy modes this is 万円 = 10,000 JPY units (e.g. 2000 = ¥20,000,000)." }, "priceMax": { "title": "Max price (rent: JPY/month, buy: 万円)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional upper price bound, applied client-side. UNIT SWITCHES BY MODE: for mode=rent this is JPY per month (e.g. 150000 = ¥150,000/month); for buy modes this is 万円 = 10,000 JPY units (e.g. 5000 = ¥50,000,000)." }, "layoutMin": { "title": "Minimum layout", "type": "string", "description": "Optional minimum floor plan, e.g. \"1K\", \"1LDK\", \"2DK\", \"3LDK\" — listings with a smaller layout are filtered out client-side (ワンルーム < 1K < 1DK < 1LDK < 2K < …). Ignored for land." }, "ageMax": { "title": "Max building age (years)", "minimum": 0, "maximum": 200, "type": "integer", "description": "Optional maximum building age in years (築年数), e.g. 10 = built within the last 10 years. Applied client-side; listings without a published age are excluded when set." }, "detailFetch": { "title": "Fetch rent detail pages", "type": "boolean", "description": "Rent mode only: when true, each unit costs one extra request but adds built year/month, structure, total units, refined building type and the handling agency's business name. Buy-mode list pages already carry every output field, so this flag is ignored for buy modes. Default false (cheaper).", "default": false }, "maxItems": { "title": "Max records", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many dataset records.", "default": 50 }, "maxApiRequests": { "title": "Max upstream requests", "minimum": 1, "maximum": 60, "type": "integer", "description": "Hard budget of HTTP requests to suumo.jp for this run (1 city-index page + list pages of ~30-100 listings + 1 per rent detail when detailFetch is on). Requests are strictly serial with >= 1.2 s spacing. When the budget runs out the run completes with complete=false in RUN_SUMMARY.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy settings. Default: no proxy. Never used for rotation/evasion — one client identity per run." } } }, "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 } } } } } } } } } }