{ "openapi": "3.0.1", "info": { "title": "SUUMO Scraper 🔥 Japan Real Estate & Rentals 🏠", "description": "Scrape Japan real estate from SUUMO — rentals, new & used mansions, detached houses, and land. Rent, deposit, key money, sale price, layout, area, year built, walk-to-station, photos, and agency contacts. Paste a SUUMO search URL or filter by prefecture/city/station. JSON, CSV, Excel, or API.", "version": "0.0", "x-build-id": "d4WxMlbyQMW85ZQkf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~suumo-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-suumo-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/memo23~suumo-scraper/runs": { "post": { "operationId": "runs-sync-memo23-suumo-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/memo23~suumo-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-suumo-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": { "startUrl": { "title": "Start URL", "type": "string", "description": "A SUUMO search URL (e.g. https://suumo.jp/chintai/tokyo/sc_shinjuku/) or a direct listing URL. Optional — overrides the filters below when set." }, "listingType": { "title": "Listing type", "enum": [ "rent", "newMansion", "newDetached", "land" ], "type": "string", "description": "Property category to search. Ignored when startUrl is a category URL.", "default": "rent" }, "prefecture": { "title": "Prefecture code", "type": "string", "description": "JIS prefecture code (TF param). 13 = Tokyo, 27 = Osaka, 14 = Kanagawa. See https://en.wikipedia.org/wiki/ISO_3166-2:JP. Leave empty to search all of Japan." }, "cities": { "title": "City / ward codes", "type": "array", "description": "JIS 5-digit city/ward codes (SC param, repeatable). E.g. 13104 = Shinjuku, 13113 = Shibuya. Tokyo ward romaji slugs in startUrl are auto-resolved.", "items": { "type": "string" } }, "stations": { "title": "Station codes", "type": "array", "description": "SUUMO station codes (E param, repeatable). Combine with listingType for station-based searches.", "items": { "type": "string" } }, "rentMin": { "title": "Min rent (yen)", "minimum": 0, "type": "integer", "description": "Minimum monthly rent in yen. Rentals only." }, "rentMax": { "title": "Max rent (yen)", "minimum": 0, "type": "integer", "description": "Maximum monthly rent in yen. Rentals only." }, "priceMin": { "title": "Min price (yen)", "minimum": 0, "type": "integer", "description": "Minimum sale price in yen. Sales only." }, "priceMax": { "title": "Max price (yen)", "minimum": 0, "type": "integer", "description": "Maximum sale price in yen. Sales only." }, "areaMin": { "title": "Min area (m²)", "minimum": 0, "type": "integer", "description": "Minimum floor area in square metres." }, "areaMax": { "title": "Max area (m²)", "minimum": 0, "type": "integer", "description": "Maximum floor area in square metres." }, "walkTime": { "title": "Max walk to station (min)", "minimum": 1, "maximum": 60, "type": "integer", "description": "Maximum walking time to the nearest station in minutes." }, "onlyWithPhotos": { "title": "Only listings with photos", "type": "boolean", "description": "Filter out listings without photos.", "default": false }, "onlyNew": { "title": "Only new listings", "type": "boolean", "description": "Return only the newest listings.", "default": false }, "petsAllowed": { "title": "Pet-friendly only", "type": "boolean", "description": "Rentals that allow pets.", "default": false }, "fetchFullDetails": { "title": "Fetch full listing details", "type": "boolean", "description": "Fetch the detail page for each listing (photo gallery, deposit, key money, management fee, full transport, agency phone). Off: search-card fields only.", "default": true }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "How many listings to save. Default 100. Free plan runs are capped at 5.", "default": 100 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Optional. SUUMO's mobile API has no anti-bot, so a proxy is usually unnecessary. Use Apify Proxy or a custom proxy URL if you need geo-routing.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }