{ "openapi": "3.0.1", "info": { "title": "Tokyu Livable Scraper β€” Japan Property Data & API", "description": "Tokyu Livable (livable.co.jp) scraper & Japan real estate data API. For-sale apartments, houses & land: price (JPY), layout, area, floor, building age, fees, lat/lng, station access, photos β€” clean JSON/CSV, one row per listing. Fast overview or full detail. No account needed.", "version": "1.0", "x-build-id": "aGwabagJ1fFbpp1Va" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~tokyu-livable-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-tokyu-livable-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~tokyu-livable-property-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-tokyu-livable-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~tokyu-livable-property-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-tokyu-livable-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): listing cards from the ward results β€” one row per property with price, layout, area, floor, building age, address, station access & photos.\n\nπŸ”Ž **DETAIL** (enrich): fetches each listing's full page for the spec table β€” fees, total units, land rights, builder/developer, balcony area, GPS coordinates, structure, transaction type, full image set, equipment. Detail merges overview + detail into one record.", "default": "overview" }, "searchMode": { "title": "πŸ”€ Search mode", "enum": [ "byArea", "bySearchUrl", "byListingUrl" ], "type": "string", "description": "πŸ”€ How listings are discovered.\n\n- **byArea** β€” give a prefecture slug (e.g. `tokyo`) + one or more ward area ids (e.g. `a13103` for Minato).\n- **bySearchUrl** β€” paste a ready-made livable.co.jp ward results URL with your filters applied in the UI (most reliable).\n- **byListingUrl** β€” fetch specific listings directly (DETAIL only).", "default": "byArea" }, "propertyType": { "title": "🏘️ Property type", "enum": [ "chuko-mansion", "chuko-kodate", "shinchiku-mansion", "shinchiku-kodate", "mansion", "kodate", "tochi", "bukken-all" ], "type": "string", "description": "🏘️ Which Tokyu Livable for-sale vertical to scrape (the `/kounyu//` segment).", "default": "chuko-mansion" }, "pref": { "title": "πŸ—Ύ Prefecture", "type": "string", "description": "πŸ—Ύ **BY AREA:** Prefecture slug, e.g. `tokyo`, `kanagawa`, `osaka`, `aichi`, `fukuoka`. Used with `areaIds`.", "default": "tokyo" }, "areaIds": { "title": "πŸ“ Ward area ids", "type": "array", "description": "πŸ“ **BY AREA:** Tokyu Livable ward area ids to scrape (e.g. `a13103` = Minato, `a13113` = Shibuya). Find them in the URL on a livable.co.jp ward results page.\n\nπŸ’‘ **TIP:** For precise filtering, use **bySearchUrl** instead β€” apply your filters in the livable.co.jp UI and paste the URL.", "default": [ "a13103" ], "items": { "type": "string" } }, "searchUrls": { "title": "πŸ”— Search URLs", "type": "array", "description": "πŸ”— **BY SEARCH URL:** Paste one or more livable.co.jp ward results URLs (the `/kounyu////` pages). Apply all your filters in the UI first, then copy the address β€” every filter and sort is preserved.", "items": { "type": "string" } }, "listingUrls": { "title": "🏠 Listing URLs", "type": "array", "description": "🏠 **BY LISTING URL (DETAIL ONLY):** Paste livable.co.jp detail URLs (e.g. `https://www.livable.co.jp/mansion/C13266W50/`) or bare property codes (e.g. `C13266W50`). Used with scrapeMode = detail.", "items": { "type": "string" } }, "sort": { "title": "↕️ Sort order", "enum": [ "newer", "address", "route", "walk", "price_low_to_high" ], "type": "string", "description": "↕️ Result sort order (applied to byArea searches).", "default": "newer" }, "filters": { "title": "πŸŽ›οΈ Extra filters", "type": "array", "description": "πŸŽ›οΈ **OPTIONAL:** Extra livable.co.jp query filters as `key=value`, applied to byArea searches. Examples: `priceTo=8000` (max price 万円), `areaFrom=50` (min mΒ²), `ageTo=10` (max building age), `walkTo=10` (max walk minutes), `facing=south`.", "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** β€” livable.co.jp is reachable without a proxy, so leaving this off keeps runs fast and cheap. Enable only if you hit a 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 } } } } } } } } } }