{ "openapi": "3.0.1", "info": { "title": "able Property Scraper — Japan Rental Data & API", "description": "able (エイブル) rental scraper & real estate data API for able.co.jp. Apartment & house rent listings: rent, layout, area, floor, deposit, key money, brokerage fee, building age & structure, station access, photos — clean JSON/CSV, one row per unit. Fast overview or full detail. No account needed.", "version": "1.0", "x-build-id": "avMW5tvCp7cKgEeYM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~able-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-able-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/sian.agency~able-property-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-able-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/sian.agency~able-property-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-able-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": { "scrapeMode": { "title": "🧭 Scrape mode", "enum": [ "overview", "detail" ], "type": "string", "description": "🧭 **OVERVIEW** (cheap, primary): unit-level cards from the area list — one row per listing, with rent, layout, area, floor, deposit, key money, building age, structure, station access & photos.\n\n🔎 **DETAIL** (enrich): fetches each listing's full page for the spec table — full fee breakdown, brokerage fee, orientation, building type, latitude/longitude, equipment, security, room features, hi-res photo gallery. Detail merges overview + detail into one record.", "default": "overview" }, "searchMode": { "title": "🔀 Search mode", "enum": [ "bySearchUrl", "byArea", "byListingUrl" ], "type": "string", "description": "🔀 How listings are discovered.\n\n- **bySearchUrl** — paste a ready-made able area-list URL with your filters applied in the UI (most reliable).\n- **byArea** — give a prefecture slug and one or more JIS municipal codes.\n- **byListingUrl** — fetch specific listings directly (DETAIL only).", "default": "bySearchUrl" }, "searchUrls": { "title": "🔗 Search URLs", "type": "array", "description": "🔗 **BY SEARCH URL:** Paste one or more able area-list URLs (the `/{prefecture}/area/{citycode}/list/` pages). Apply all your filters in the able UI first, then copy the address — every supported filter is preserved.\n\n💡 **TIP:** Example — `https://www.able.co.jp/tokyo/area/13104/list/`", "default": [ "https://www.able.co.jp/tokyo/area/13104/list/" ], "items": { "type": "string" } }, "pref": { "title": "🏯 Prefecture slug", "type": "string", "description": "🏯 **BY AREA:** Prefecture slug used in able URLs. Examples: `tokyo`, `osaka`, `kanagawa`, `aichi`, `fukuoka`." }, "cityCodes": { "title": "🔢 JIS city codes", "type": "array", "description": "🔢 **BY AREA:** One or more JIS municipal codes to scrape. Example: `13104` = Shinjuku-ku, Tokyo.", "items": { "type": "string" } }, "listingUrls": { "title": "🏠 Listing URLs", "type": "array", "description": "🏠 **BY LISTING URL (DETAIL ONLY):** Paste able detail URLs (e.g. `https://www.able.co.jp/detail/Detail.do?bk=000000051506936046&prefkey=tokyo&g=13104`). Used with scrapeMode = detail.", "items": { "type": "string" } }, "maxResults": { "title": "🔢 Max results", "minimum": 1, "type": "integer", "description": "🔢 Maximum listings to return per run. **FREE users:** capped at 25 · **PAID users:** unlimited.", "default": 100 }, "maxPages": { "title": "📄 Max pages", "minimum": 1, "type": "integer", "description": "📄 Maximum area-list pages to paginate per search before stopping.", "default": 5 }, "order": { "title": "↕️ Sort order", "type": "string", "description": "↕️ able's own sort/order parameter (`o`), carried verbatim. Leave blank for the default feed order." }, "rentMin": { "title": "💴 Rent min", "type": "string", "description": "💴 Minimum rent filter (able `cf`)." }, "rentMax": { "title": "💴 Rent max", "type": "string", "description": "💴 Maximum rent filter (able `ct`)." }, "areaMin": { "title": "📐 Area min (m²)", "type": "string", "description": "📐 Minimum floor area in m² (able `sf`)." }, "areaMax": { "title": "📐 Area max (m²)", "type": "string", "description": "📐 Maximum floor area in m² (able `st`)." }, "buildingType": { "title": "🏢 Building type", "type": "array", "description": "🏢 Building-type filter (able `b`, repeatable): `1` = mansion, `2` = apartment, `3` = house.", "items": { "type": "string" } }, "useProxy": { "title": "🌐 Use Japan residential proxy", "type": "boolean", "description": "🌐 Route requests through a Japan residential proxy. **Off by default** — able.co.jp is reachable without a proxy, so leaving this off keeps runs fast and cheap. Enable only if you hit a rate-limit or geo-block.", "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 } } } } } } } } } }