{ "openapi": "3.0.1", "info": { "title": "SUUMO Property Investment Analyzer", "description": "An Apify Actor that fetches SUUMO used-condo listings (by individual URL or by area × building-age filters), then cross-references area and floor-plan rent averages to estimate gross rental yield and an age-adjusted net yield benchmark. Pay-per-event pricing.", "version": "0.1", "x-build-id": "VModt9XbYyz8qDcQc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/woolen_snake~suumo-investment-analyzer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-woolen_snake-suumo-investment-analyzer", "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/woolen_snake~suumo-investment-analyzer/runs": { "post": { "operationId": "runs-sync-woolen_snake-suumo-investment-analyzer", "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/woolen_snake~suumo-investment-analyzer/run-sync": { "post": { "operationId": "run-sync-woolen_snake-suumo-investment-analyzer", "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": [ "mode" ], "properties": { "mode": { "title": "Fetch mode", "enum": [ "byUrl", "byArea" ], "type": "string", "description": "byUrl: analyze only the properties given in propertyUrls. byArea: crawl an area using the prefecture/city/maxBuildingAgeYears criteria and analyze matching properties.", "default": "byArea" }, "propertyUrls": { "title": "Property URLs (for byUrl mode)", "type": "array", "description": "SUUMO used-condo detail page URLs to analyze (format: https://suumo.jp/ms/chuko/.../nc_.../, e.g. https://suumo.jp/ms/chuko/osaka/sc_suita/nc_20946138/). Used when mode is byUrl.", "items": { "type": "string" }, "default": [] }, "prefecture": { "title": "Prefecture segment (for byArea mode)", "type": "string", "description": "The prefecture segment used in SUUMO's URL path (e.g. \"tokyo\" for Tokyo, \"osaka\" for Osaka Prefecture). Used as https://suumo.jp/ms/chuko/[this value]/[city]/. Open the used-condo listing page for your target area to confirm it.", "default": "" }, "city": { "title": "City segment (for byArea mode)", "type": "string", "description": "The city/ward segment used in SUUMO's URL path (e.g. \"sc_setagaya\" for Setagaya Ward). Open the used-condo listing page for your target area and check the part starting with \"sc_\" in the URL.", "default": "" }, "maxBuildingAgeYears": { "title": "Max building age (for byArea mode)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only properties at or under this building age are analyzed.", "default": 30 }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 200, "type": "integer", "description": "Cap on the number of properties analyzed and output. A charge event is generated per property, so this directly drives run cost.", "default": 20 }, "maxDetailFetches": { "title": "Detail page fetch cap (safety limit)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "In byArea mode, the upper limit on how many detail pages are actually accessed, including properties that don't match maxBuildingAgeYears (only matching, output properties are charged).", "default": 100 }, "requestDelayMs": { "title": "Request delay (ms)", "minimum": 1000, "maximum": 10000, "type": "integer", "description": "Delay between each request, to reduce load on SUUMO's servers and avoid access blocking (IP blocks). Cannot be set below 1000ms for safety.", "default": 2000 } } }, "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 } } } } } } } } } }