{ "openapi": "3.0.1", "info": { "title": "SUUMO Scraper - Japan Property Listings", "description": "Collect SUUMO property listings across Japan: prices, floor plans, areas, station access, photos, and public agency contacts. Pay per delivered row plus a small start fee.", "version": "0.4", "x-build-id": "dFDvnmwT76dET2agG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~suumo-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-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/lentic_clockss~suumo-property-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-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/lentic_clockss~suumo-property-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "SUUMO search or property detail URLs, each with its own maxItems allowance. Use full HTTPS links on suumo.jp or www.suumo.jp; search URLs select the area and property category.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "location": { "title": "Location path", "type": "string", "description": "Use a SUUMO city or ward path, such as tokyo/sc_shinjuku or osaka/sc_osakashikita, rather than a bare prefecture. This selects one area when startUrls is empty; some familiar place names are also accepted." }, "propertyType": { "title": "Property type", "enum": [ "chuko_mansion", "shinchiku_mansion", "ikkodate", "chukoikkodate", "tochi", "chintai" ], "type": "string", "description": "Property category for an area or code-based search. A web search URL selects its own category.", "default": "chuko_mansion" }, "channel": { "title": "Sale or rent (compatibility setting)", "enum": [ "BUY", "RENT" ], "type": "string", "description": "Prefer propertyType for category selection. RENT selects rentals when propertyType is omitted or left at chuko_mansion; an explicit non-default category wins.", "default": "BUY" }, "maxItems": { "title": "Maximum rows per input", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum rows for each URL or selected area, from 1 to 2,000, with a default of 70; larger requests are collected in smaller parts. The whole run also respects your spending cap and, on the Free plan, the limits of 200 rows per run and 10 runs total.", "default": 70 }, "maxPages": { "title": "Search page setting", "minimum": 1, "maximum": 100, "type": "integer", "description": "Page setting from 1 to 100. Collection may continue beyond this value to reach maxItems, so use maxItems and the run spending cap to limit collection.", "default": 1 }, "scrapeDetails": { "title": "Scrape detail pages", "type": "boolean", "description": "Include available detail-page fields in each row. App rental detail pages are skipped; existing App listing and contact fields remain included.", "default": true }, "provider": { "title": "Listing source", "enum": [ "curl", "app", "map" ], "type": "string", "description": "Choose web pages for URLs or location, App listings for administrative codes, or map search for a map area. App and map searches require prefectureCode and do not accept startUrls.", "default": "curl" }, "prefectureCode": { "title": "Prefecture code", "pattern": "^(0[1-9]|[1-3][0-9]|4[0-7])$", "type": "string", "description": "Two-digit code from 01 to 47, required for App and map searches; use 13 for Tokyo or 27 for Osaka. Leave empty for web searches." }, "cityCode": { "title": "City or ward code", "pattern": "^[0-9]{5}$", "type": "string", "description": "Five-digit city or ward code, such as 13104 for Shinjuku, starting with prefectureCode. Optional for App and sale map searches; required for map rentals." }, "bbox": { "title": "Map area", "type": "object", "description": "Required for map searches: enter corners {lat1,lng1,lat2,lng2} or a centre and radius {lat,lng,radiusKm}. Coordinates are degrees and the radius is kilometres." }, "pageSize": { "title": "App listings per page", "minimum": 1, "maximum": 50, "type": "integer", "description": "Requested App listings per page, from 1 to 50. maxItems limits the delivered rows for the selected area.", "default": 50 }, "requestDelayMillis": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Delay between collection requests in milliseconds, from 0 to 15,000.", "default": 800 }, "maxConcurrency": { "title": "Request concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Requested number of concurrent detail-page requests, from 1 to 8. Map detail collection can use at least 4.", "default": 2 }, "workerBaseUrl": { "title": "Developer test URL", "type": "string", "description": "Leave empty. Used only by the developer for testing." } } }, "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 } } } } } } } } } }