{ "openapi": "3.0.1", "info": { "title": "at home Scraper — Japan Rental Property Data & API", "description": "at home (athome.co.jp) scraper & real estate data API for Japan rental listings. Extract rent, layout, floor area, deposit, key money, building age, station access, lat/long geo, agent contacts & photos — clean JSON/CSV, one row per room. アットホームの物件データを取得。No account needed.", "version": "1.0", "x-build-id": "6p4d0TET0rZbjJkFI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~athome-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-athome-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~athome-property-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-athome-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~athome-property-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-athome-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): room-level cards from the search results — one row per rentable unit, with rent, layout, area, station access & photos.\n\n🔎 **DETAIL** (enrich): fetches each listing's full page (JSON-LD + spec table) for price in JPY, geo lat/long, deposit, key money, building age, parking, facilities, agent contacts & full image set. Detail merges overview + detail into one record.", "default": "overview" }, "searchMode": { "title": "🔀 Search mode", "enum": [ "byPlace", "bySearchUrl", "byListingUrl" ], "type": "string", "description": "🔀 How listings are discovered.\n\n- **byPlace** — give one or more athome prefecture slugs (e.g. `tokyo`) with optional ward/city slugs.\n- **bySearchUrl** — paste a ready-made athome search URL with your filters applied in the UI (most reliable).\n- **byListingUrl** — fetch specific listings directly (DETAIL only).", "default": "byPlace" }, "places": { "title": "📍 Prefecture slugs", "type": "array", "description": "📍 **BY PREFECTURE:** athome prefecture slugs to scrape. Examples: `tokyo`, `osaka`, `kanagawa`, `aichi`, `fukuoka`. Builds `/chintai/{prefecture}/list/`.\n\n💡 **TIP:** For precise filtering, use **bySearchUrl** instead — apply your filters in athome's UI and paste the URL.", "default": [ "tokyo" ], "items": { "type": "string" } }, "wards": { "title": "🏙️ Ward / city slugs", "type": "array", "description": "🏙️ **OPTIONAL (byPlace):** Ward or city slugs paired with `places` by position (e.g. `shinjuku-city`). Builds `/chintai/{prefecture}/{ward}/list/`. Leave empty to scrape the whole prefecture.", "items": { "type": "string" } }, "searchUrls": { "title": "🔗 Search URLs", "type": "array", "description": "🔗 **BY SEARCH URL:** Paste one or more athome.co.jp search-results URLs (the `/chintai/.../list/` pages). Apply all your filters in the athome UI first, then copy the address — every path-segment filter is preserved.", "items": { "type": "string" } }, "listingUrls": { "title": "🏠 Listing URLs", "type": "array", "description": "🏠 **BY LISTING URL (DETAIL ONLY):** Paste athome detail URLs (e.g. `https://www.athome.co.jp/chintai/6990708422/`) or bare listing codes. Used with scrapeMode = detail.", "items": { "type": "string" } }, "filters": { "title": "🎛️ Extra filters", "type": "array", "description": "🎛️ **OPTIONAL:** Extra athome path-segment filters applied to byPlace searches. Examples: `1ldk` (layout), `pet` (pets allowed), `mansion` (building type), `walk10` (≤10 min walk), `within-10year` (build age). Each is appended to the search path.", "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 }, "useProxy": { "title": "🌐 Use Japan residential proxy", "type": "boolean", "description": "🌐 Route requests through a Japan residential proxy. **Off by default** — athome.co.jp is reachable without a proxy, so leaving this off keeps runs fast and cheap. Enable only if you hit a soft per-IP rate-gate at scale.", "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 } } } } } } } } } }