{
  "openapi": "3.0.1",
  "info": {
    "title": "LIFULL HOME'S Scraper — Japan Property Data & API",
    "description": "LIFULL HOME'S scraper & real estate data API for homes.co.jp, a top Japan property portal. Rent & sale: rent, layout, area, floor, deposit, key money, building age, station access, equipment, photos — clean JSON/CSV, one row per room. Fast overview or full detail. No account needed.",
    "version": "1.0",
    "x-build-id": "sp8yYoCQLpafAUI55"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~lifull-homes-property-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-lifull-homes-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~lifull-homes-property-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-lifull-homes-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~lifull-homes-property-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-lifull-homes-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, floor, deposit, key money, building age, address & station access.\n\n🔎 **DETAIL** (enrich): fetches each listing's full page for the complete spec table — structure, exact build month, orientation, balcony, parking, equipment list, contract terms, agency & the 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 prefecture/region slugs (e.g. `tokyo`, `osaka`, `kanagawa`) + a vertical.\n- **bySearchUrl** — paste a ready-made homes.co.jp search URL with your filters applied in the UI (most reliable).\n- **byListingUrl** — fetch specific listings directly (DETAIL only).",
            "default": "byPlace"
          },
          "vertical": {
            "title": "🏘️ Vertical",
            "enum": [
              "rent",
              "mansion"
            ],
            "type": "string",
            "description": "🏘️ Which LIFULL HOME'S vertical to scrape.\n\n- **rent** (賃貸) — fully supported; explodes each building into one row per room.\n- **mansion** (中古マンション, used mansion) — sale vertical (partial coverage; use `rent` for the richest data).",
            "default": "rent"
          },
          "places": {
            "title": "📍 Prefecture / region slugs",
            "type": "array",
            "description": "📍 **BY PREFECTURE:** homes.co.jp prefecture/region slugs to scrape. Common slugs: `tokyo` (東京), `osaka` (大阪), `kanagawa` (神奈川), `aichi` (愛知), `fukuoka` (福岡), `hokkaido` (北海道).\n\n💡 **TIP:** For precise filtering, use **bySearchUrl** instead — apply your filters in the homes.co.jp UI and paste the URL.",
            "default": [
              "tokyo"
            ],
            "items": {
              "type": "string"
            }
          },
          "searchUrls": {
            "title": "🔗 Search URLs",
            "type": "array",
            "description": "🔗 **BY SEARCH URL:** Paste one or more homes.co.jp search-results URLs (the `/chintai/{pref}/list/` or `/mansion/chuko/{pref}/list/` pages). Apply all your filters in the homes.co.jp UI first, then copy the address — every `cond[...]` filter is preserved.",
            "items": {
              "type": "string"
            }
          },
          "listingUrls": {
            "title": "🏠 Listing URLs",
            "type": "array",
            "description": "🏠 **BY LISTING URL (DETAIL ONLY):** Paste homes.co.jp detail URLs (e.g. `https://www.homes.co.jp/chintai/room/086345…/`) or bare 40-character room hashes. Used with scrapeMode = detail.",
            "items": {
              "type": "string"
            }
          },
          "sort": {
            "title": "↕️ Sort",
            "enum": [
              "recommend",
              "fee",
              "-fee",
              "area_house",
              "period",
              "newdate",
              "addr"
            ],
            "type": "string",
            "description": "↕️ **OPTIONAL:** Result ordering (homes.co.jp `cond[sortby]`), applied to byPlace searches."
          },
          "filters": {
            "title": "🎛️ Extra filters",
            "type": "array",
            "description": "🎛️ **OPTIONAL:** Extra homes.co.jp query filters as `key=value`, applied to byPlace searches. Examples: `cond[priceLow]=70000` (min rent JPY), `cond[priceHigh]=120000` (max rent), `cond[houseAreaLow]=20` (min m²), `cond[walkMinutes]=10` (max walk to station).",
            "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** — homes.co.jp is reachable without a proxy, so leaving this off keeps runs fast and cheap. Enable only if you hit a rate- 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}