{ "openapi": "3.0.1", "info": { "title": "SUUMO Rental Property Scraper (Japan)", "description": "Scrapes rental apartments from SUUMO — Japan's #1 property portal. Search 15 prefectures by ward, rent, layout, size and walk time to a station. One row per unit: rent, admin fee, deposit, key money, layout, floor, area, plus building address and stations.", "version": "0.1", "x-build-id": "hv1rXAC8ogkfwGOqT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapyx~suumo-properties-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapyx-suumo-properties-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/scrapyx~suumo-properties-scraper/runs": { "post": { "operationId": "runs-sync-scrapyx-suumo-properties-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/scrapyx~suumo-properties-scraper/run-sync": { "post": { "operationId": "run-sync-scrapyx-suumo-properties-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": { "prefecture": { "title": "Prefecture", "enum": [ "tokyo", "kanagawa", "saitama", "chiba", "osaka", "kyoto", "hyogo", "aichi", "shizuoka", "fukuoka", "hokkaido", "miyagi", "hiroshima", "niigata", "kagawa" ], "type": "string", "description": "Which prefecture to search. Only pairs verified to return listings are offered — SUUMO pairs a region code with a prefecture code internally and answers a mismatched pair with an EMPTY page rather than an error, so unverified combinations are refused instead of silently returning nothing.", "default": "tokyo" }, "cityCodes": { "title": "City / ward codes (sc)", "type": "array", "description": "Optional SUUMO `sc` codes to narrow to specific wards or cities, e.g. 13104 = Shinjuku, 13113 = Shibuya, 13101 = Chiyoda. Leave empty for the whole prefecture. To find a code, run the search on suumo.jp and read `sc=` out of the URL. Codes must belong to the chosen prefecture — SUUMO returns an empty page rather than an error if they do not.", "default": [], "items": { "type": "string" } }, "minRent": { "title": "Minimum rent (万円 / man-yen per month)", "type": "string", "description": "In man-yen (units of 10,000 JPY), as SUUMO expresses it: 8 means 80,000 yen, 8.5 means 85,000 yen. Leave empty for no minimum.", "default": "" }, "maxRent": { "title": "Maximum rent (万円 / man-yen per month)", "type": "string", "description": "In man-yen (units of 10,000 JPY): 15 means 150,000 yen. Leave empty for no maximum.", "default": "" }, "layouts": { "title": "Layout (間取り / madori)", "type": "array", "description": "Select one or more floor-plan types. Leave empty for any.", "items": { "type": "string", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13" ], "enumTitles": [ "1R (one room)", "1K", "1DK", "1LDK", "2K", "2DK", "2LDK", "3K", "3DK", "3LDK", "4K", "4DK", "4LDK or larger" ] }, "default": [] }, "minArea": { "title": "Minimum area (m²)", "minimum": 0, "type": "integer", "description": "Leave empty or 0 for any.", "default": 0 }, "maxArea": { "title": "Maximum area (m²)", "minimum": 0, "type": "integer", "description": "Leave empty or 0 for any.", "default": 0 }, "maxWalkMinutes": { "title": "Max walk to station (minutes)", "minimum": 0, "maximum": 30, "type": "integer", "description": "Only return properties within this many minutes' walk of a station. Leave empty or 0 for any.", "default": 0 }, "maxItems": { "title": "Max rooms", "minimum": 0, "type": "integer", "description": "Stop after this many rentable units. Set to 0 for unlimited. Note one page of 30 buildings carries roughly 265 units, so this fills up faster than a per-listing count would suggest.", "default": 100 }, "maxConcurrency": { "title": "Max concurrent requests", "minimum": 1, "maximum": 8, "type": "integer", "description": "Deliberately low by default. SUUMO answers bursts of requests with HTTP 503, so this actor paces itself rather than racing; raising this makes runs slower, not faster, once throttling kicks in.", "default": 2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "SUUMO has no bot challenge, but it does rate-limit by IP — Residential lets a long crawl rotate exits rather than backing off on one address.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }