{ "openapi": "3.0.1", "info": { "title": "SUUMO Rentals - New Listings by Ward", "description": "SUUMO rental search, one flat row per room: rent, admin fee, deposit, key money, layout, area, floor, building age and access lines. Search by a pasted SUUMO search URL or by prefecture + city codes, newest-first.", "version": "0.1", "x-build-id": "An3heyrb6Z5efYWdh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/superslowsloth~suumo-rentals/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-superslowsloth-suumo-rentals", "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/superslowsloth~suumo-rentals/runs": { "post": { "operationId": "runs-sync-superslowsloth-suumo-rentals", "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/superslowsloth~suumo-rentals/run-sync": { "post": { "operationId": "run-sync-superslowsloth-suumo-rentals", "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": { "searchUrls": { "title": "SUUMO search URLs", "type": "array", "description": "One or more rental search URLs copied straight from suumo.jp, e.g. https://suumo.jp/jj/chintai/ichiran/FR301FC001/?ar=030&bs=040&ta=13&sc=13113 (東京都渋谷区). Every filter already on the URL - rent band, layout, \"no key money\" - is kept; only the page number is driven by this actor. This is the recommended way to run a search outside the Kanto region, since it carries the correct area code (ar) already.", "items": { "type": "string" } }, "prefectureCode": { "title": "Prefecture code (ta)", "type": "string", "description": "SUUMO's own prefecture code, the `ta` parameter of a search URL - e.g. \"13\" for Tokyo. Used together with Ward/city codes below to build a search when you have not pasted a URL." }, "cityCodes": { "title": "Ward / city codes (sc)", "type": "array", "description": "SUUMO's own ward/city codes, the `sc` parameter of a search URL - e.g. \"13113\" for Shibuya-ku. One search is run per code, sharing the prefecture and area codes above.", "items": { "type": "string" } }, "areaCode": { "title": "Region code (ar)", "type": "string", "description": "SUUMO's own region grouping, the `ar` parameter of a search URL. \"030\" is Kanto and covers every prefecture this actor was measured against; a search outside Kanto needs the real code, read off a URL copied from the site - use Search URLs above instead if you are not sure.", "default": "030" }, "sortNewest": { "title": "Sort newest first", "type": "boolean", "description": "Ask SUUMO for its own \"新着順\" (newest-first) order before paging through results. On by default, since finding new listings is what this actor is for; turn it off to keep whatever sort a pasted search URL already carries.", "default": true }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Stop after this many rooms across all searches in this run. One room is one billed row; a building with several vacant rooms counts as several.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Datacenter is the default here: SUUMO answers a datacenter exit with real results. Residential also works, but only when pinned to Japan (apifyProxyCountry \"JP\") - an unpinned residential exit gets SUUMO's own \"access congestion\" apology page, served as a plain HTTP 200, which reads exactly like a genuine block.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }