{ "openapi": "3.0.1", "info": { "title": "SUUMO Scraper", "description": "Scrape suumo.jp - Japan's largest real-estate portal. Search used condos, new houses, used houses and land across all 47 prefectures by price, floor area and build year.", "version": "1.0", "x-build-id": "dW3jjTbI64ILi03XA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~suumo-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-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/crawlerbros~suumo-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-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/crawlerbros~suumo-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-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": { "propertyType": { "title": "Property type", "enum": [ "usedCondo", "newHouse", "usedHouse", "land" ], "type": "string", "description": "Type of property to search for purchase.", "default": "usedCondo" }, "prefecture": { "title": "Prefecture", "enum": [ "hokkaido", "aomori", "iwate", "miyagi", "akita", "yamagata", "fukushima", "ibaraki", "tochigi", "gumma", "saitama", "chiba", "tokyo", "kanagawa", "niigata", "toyama", "ishikawa", "fukui", "yamanashi", "nagano", "gifu", "shizuoka", "aichi", "mie", "shiga", "kyoto", "osaka", "hyogo", "nara", "wakayama", "tottori", "shimane", "okayama", "hiroshima", "yamaguchi", "tokushima", "kagawa", "ehime", "kochi", "fukuoka", "saga", "nagasaki", "kumamoto", "oita", "miyazaki", "kagoshima", "okinawa" ], "type": "string", "description": "Japanese prefecture to search within.", "default": "tokyo" }, "priceMinJpy": { "title": "Min price (JPY)", "minimum": 0, "maximum": 100000000000, "type": "integer", "description": "Minimum listing price in Japanese yen." }, "priceMaxJpy": { "title": "Max price (JPY)", "minimum": 0, "maximum": 100000000000, "type": "integer", "description": "Maximum listing price in Japanese yen." }, "floorAreaMinSqm": { "title": "Min floor/land area (m²)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Minimum floor area (for condos/houses) or land area (for land listings), in square meters." }, "floorAreaMaxSqm": { "title": "Max floor/land area (m²)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum floor area (for condos/houses) or land area (for land listings), in square meters." }, "builtYearMin": { "title": "Min built year", "minimum": 1850, "maximum": 2100, "type": "integer", "description": "Drop listings built before this year (not applicable to land/new-build listings, which have no build date yet)." }, "layoutCategory": { "title": "Room layout (propertyType != land)", "enum": [ "studio", "1", "2", "3", "4", "5plus" ], "type": "string", "description": "Only keep listings matching this room-layout category, e.g. `3K/DK/LDK`. Not applicable to land listings." }, "maxWalkMinutes": { "title": "Max walk to station (minutes)", "minimum": 1, "maximum": 60, "type": "integer", "description": "Only keep listings within this many minutes' walk of the nearest train station. suumo.jp's own filter panel offers 1/3/5/7/10/15/20-minute presets, but any value in range is accepted." }, "sortBy": { "title": "Sort order", "enum": [ "newest", "priceAsc", "priceDesc", "areaAsc", "areaDesc", "layoutFewRooms", "layoutManyRooms", "builtOldest", "builtNewest" ], "type": "string", "description": "How suumo.jp orders results server-side before pagination." }, "keyword": { "title": "Keyword filter", "type": "string", "description": "Only keep listings whose property name/title/address/layout contains this text (case-insensitive)." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum number of listings to scrape.", "default": 30 } } }, "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 } } } } } } } } } }