{ "openapi": "3.0.1", "info": { "title": "athome Scraper - Japan Rentals, Homes for Sale & Land", "description": "Scrape athome.co.jp (Japan real estate) rentals and homes for sale in one Actor: rent, management fee, deposit, key money, price, layout, area, floor, age, address, stations with walk time, agency. Optional details: GPS, equipment, contract, agency phone. Filter by prefecture, city, price, layout.", "version": "0.1", "x-build-id": "dr9TiahlegLgpTk1v" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapewise~athome-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapewise-athome-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/scrapewise~athome-scraper/runs": { "post": { "operationId": "runs-sync-scrapewise-athome-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/scrapewise~athome-scraper/run-sync": { "post": { "operationId": "run-sync-scrapewise-athome-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": { "propertyType": { "title": "Property type", "enum": [ "rent", "used-apartment", "new-apartment", "used-house", "new-house", "land" ], "type": "string", "description": "What to search. Links pasted below keep their own type.", "default": "rent" }, "prefectures": { "title": "Prefectures", "type": "array", "description": "One search per prefecture. Leave empty when you paste athome.co.jp links below.", "items": { "type": "string", "enum": [ "Hokkaido", "Aomori", "Iwate", "Miyagi", "Akita", "Yamagata", "Fukushima", "Ibaraki", "Tochigi", "Gunma", "Saitama", "Chiba", "Tokyo", "Kanagawa", "Niigata", "Toyama", "Ishikawa", "Fukui", "Yamanashi", "Nagano", "Gifu", "Shizuoka", "Aichi", "Mie", "Shiga", "Kyoto", "Osaka", "Hyogo", "Nara", "Wakayama", "Tottori", "Shimane", "Okayama", "Hiroshima", "Yamaguchi", "Tokushima", "Kagawa", "Ehime", "Kochi", "Fukuoka", "Saga", "Nagasaki", "Kumamoto", "Oita", "Miyazaki", "Kagoshima", "Okinawa" ] } }, "cities": { "title": "Cities or wards", "type": "array", "description": "Optional: cities or wards inside the chosen prefecture, in English, for example Kita, Yodogawa or Suita for Osaka, Setagaya for Tokyo. Each one is its own search. Empty = the whole prefecture.", "items": { "type": "string" } }, "stations": { "title": "Stations", "type": "array", "description": "Optional: station names in romaji as athome.co.jp spells them in its links, for example umeda or tenma. Each one is its own search.", "items": { "type": "string" } }, "minRent": { "title": "Min monthly rent (JPY)", "minimum": 0, "type": "integer", "description": "Rentals only, for example 60000." }, "maxRent": { "title": "Max monthly rent (JPY)", "minimum": 0, "type": "integer", "description": "Rentals only, for example 120000." }, "minPrice": { "title": "Min sale price (JPY)", "minimum": 0, "type": "integer", "description": "Homes and land for sale, for example 20000000." }, "maxPrice": { "title": "Max sale price (JPY)", "minimum": 0, "type": "integer", "description": "Homes and land for sale, for example 50000000." }, "layouts": { "title": "Layouts", "type": "array", "description": "Japanese floor plans: number of rooms plus L (living), D (dining), K (kitchen). 1R is a studio. Empty = all.", "items": { "type": "string", "enum": [ "1R", "1K", "1DK", "1LDK", "2K", "2DK", "2LDK", "3K", "3DK", "3LDK", "4K", "4DK", "4LDK+" ] } }, "minArea": { "title": "Min floor area (m2)", "minimum": 0, "type": "integer", "description": "For land, the land area." }, "maxArea": { "title": "Max floor area (m2)", "minimum": 0, "type": "integer", "description": "For land, the land area." }, "maxWalkMinutes": { "title": "Max walk to station (minutes)", "minimum": 1, "maximum": 20, "type": "integer", "description": "For example 10." }, "maxBuildingAge": { "title": "Max building age (years)", "minimum": 0, "maximum": 40, "type": "integer", "description": "0 = new build only." }, "postedWithinDays": { "title": "Posted within (days)", "minimum": 1, "maximum": 7, "type": "integer", "description": "1, 3 or 7: only listings published on athome.co.jp in that window." }, "sortBy": { "title": "Sort by", "enum": [ "recommended", "newest", "price-asc", "price-desc", "area-desc" ], "type": "string", "description": "Same orders as the site. onlyNew switches Recommended to Newest.", "default": "recommended" }, "startUrls": { "title": "athome.co.jp links", "type": "array", "description": "Optional: any athome.co.jp listing page (a prefecture, city, station or line list, with the filters you set on the site) or single property pages. Every page of a list is read.", "items": { "type": "string" } }, "includeDetails": { "title": "Listing details", "type": "boolean", "description": "On: opens each listing page for latitude and longitude, equipment, contract type and term, renewal fee, move-in date, estimated move-in cost, nearby shops, agency phone and licence, and all photos. Charged as an extra event.", "default": false }, "maxItems": { "title": "Max listings", "minimum": 0, "type": "integer", "description": "Cap for the whole run. 0 = no cap.", "default": 50 }, "onlyNew": { "title": "Only new listings (for schedules)", "type": "boolean", "description": "On: remembers the listings delivered in earlier runs of the same search (in your account) and delivers only listings not seen before. Skipped listings are free.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy by default. Change it only if you know you need to.", "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 } } } } } } } } } }