{ "openapi": "3.0.1", "info": { "title": "SUUMO Property Scraper", "description": "Search and extract product data from Rakuten Ichiba (Japan's largest \n e-commerce): title, price, reviews, ratings, shop info, images. API-based \n for 100% reliability. Perfect for price monitoring, competitor analysis, \n market research.", "version": "0.1", "x-build-id": "NyOZuSrAlvDWfWmFu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cloud9_ai~suumo-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cloud9_ai-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/cloud9_ai~suumo-scraper/runs": { "post": { "operationId": "runs-sync-cloud9_ai-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/cloud9_ai~suumo-scraper/run-sync": { "post": { "operationId": "run-sync-cloud9_ai-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", "required": [ "area" ], "properties": { "area": { "title": "Area / Prefecture", "type": "string", "description": "Prefecture or area to search (e.g., 'tokyo', 'osaka', 'fukuoka'). Supports English and Japanese.", "default": "tokyo" }, "districtMode": { "title": "District Mode", "enum": [ "prefecture", "ward", "custom" ], "type": "string", "description": "Prefecture level: broad search. Ward level: curated high-demand wards (better for minpaku analysis). Custom: specify sc codes manually.", "default": "prefecture" }, "customSc": { "title": "Custom District Codes (sc)", "type": "string", "description": "Comma-separated SUUMO district sc codes. Only used when districtMode=custom. Example: '13104,13113' for Shinjuku & Shibuya." }, "keyword": { "title": "Search Keyword", "type": "string", "description": "Optional keyword to filter properties (e.g., station name, area name, '民泊可')" }, "minRent": { "title": "Minimum Rent (万円)", "minimum": 0, "type": "integer", "description": "Minimum monthly rent in 万円 (e.g., 5 = 50,000 yen)" }, "maxRent": { "title": "Maximum Rent (万円)", "minimum": 0, "type": "integer", "description": "Maximum monthly rent in 万円 (e.g., 20 = 200,000 yen)" }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of properties to scrape", "default": 50 }, "enableGeocoding": { "title": "Enable Geocoding (lat/lng)", "type": "boolean", "description": "Fetch latitude/longitude via 国土地理院 API (free, no API key required). 1 API call per unique city/ward. Adds ~1-3 sec.", "default": false }, "minpakuFilter": { "title": "Minpaku (民泊) Properties Only", "type": "boolean", "description": "Only return properties explicitly mentioning 民泊可 / 民泊OK in the listing", "default": 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 } } }, "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 } } } } } } } } } }