{
  "openapi": "3.0.1",
  "info": {
    "title": "SUUMO Scraper & Japan Real Estate Monitor",
    "description": "Japan property listings from SUUMO (suumo.jp) by prefecture, city or station: used condos, houses, land and rentals. Price in yen as a number, m², layout, year built, station and walk minutes, agency. Monitoring returns only new listings and price drops. Unofficial.",
    "version": "0.1",
    "x-build-id": "nSGRJbXOf9DWVKY2W"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/neverempty~suumo-japan-real-estate-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-neverempty-suumo-japan-real-estate-monitor",
        "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/neverempty~suumo-japan-real-estate-monitor/runs": {
      "post": {
        "operationId": "runs-sync-neverempty-suumo-japan-real-estate-monitor",
        "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/neverempty~suumo-japan-real-estate-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-neverempty-suumo-japan-real-estate-monitor",
        "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": [
              "used-condo",
              "new-house",
              "used-house",
              "land",
              "rent"
            ],
            "type": "string",
            "description": "What to search on SUUMO: used condos (中古マンション), new houses (新築一戸建て), used houses (中古一戸建て), land (土地) or rentals (賃貸, one row per room). Ignored when a SUUMO search URL is given."
          },
          "prefecture": {
            "title": "Prefecture",
            "type": "string",
            "description": "SUUMO's romaji prefecture name as it appears in its addresses, e.g. tokyo, osaka, kanagawa, aichi, fukuoka. Required unless a SUUMO search URL is given."
          },
          "city": {
            "title": "City or ward",
            "type": "string",
            "description": "The city or ward: SUUMO's romaji name (shinjuku, minato, osakashikita) or the Japanese name (新宿区, 横浜市西区), which is looked up on SUUMO's prefecture page first. Leave empty when you search by station or paste a URL."
          },
          "station": {
            "title": "Station code (optional)",
            "type": "string",
            "description": "A SUUMO station code such as ek_01820 (Iidabashi), copied from a SUUMO station page address. When set, the search is around that station instead of the city. Leave empty to search by city."
          },
          "searchUrl": {
            "title": "SUUMO search URL (optional)",
            "type": "string",
            "description": "Paste a SUUMO list page, e.g. https://suumo.jp/ms/chuko/tokyo/sc_shinjuku/ or https://suumo.jp/chintai/tokyo/ek_01820/. Only the type and the area/station are used. When set, property type, prefecture, city and station are ignored. Leave empty to use the fields above."
          },
          "maxListings": {
            "title": "Maximum listings to return",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "How many listings to return (rentals: rooms). You are charged only for rows you receive. SUUMO shows 20 properties per page; empty = 20."
          },
          "maxPages": {
            "title": "Maximum pages to read",
            "minimum": 0,
            "maximum": 200,
            "type": "integer",
            "description": "Hard cap on list pages requested. 0 or empty = decided from maxListings (monitoring: 50 pages). Outside monitoring, reading pages is free and only returned listings are charged; in monitoring mode each page compared without a change is charged one search-checked event."
          },
          "minPrice": {
            "title": "Minimum price (JPY)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep listings at or above this price in yen (rentals: monthly rent). 0 or empty = no minimum. Listings whose price SUUMO does not give as a number are kept."
          },
          "maxPrice": {
            "title": "Maximum price (JPY)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep listings at or below this price in yen, e.g. 50000000 for 5,000万円 (rentals: monthly rent, e.g. 150000). 0 or empty = no maximum."
          },
          "minAreaSqm": {
            "title": "Minimum area (m²)",
            "minimum": 0,
            "type": "number",
            "description": "Floor area for condos, houses and rentals; land area for land. 0 or empty = no minimum."
          },
          "maxAreaSqm": {
            "title": "Maximum area (m²)",
            "minimum": 0,
            "type": "number",
            "description": "Floor area for condos, houses and rentals; land area for land. 0 or empty = no maximum."
          },
          "maxWalkMinutes": {
            "title": "Maximum walk to station (minutes)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep listings whose nearest station (as SUUMO lists it first) is at most this many minutes on foot. 0 or empty = any."
          },
          "minBuiltYear": {
            "title": "Built in or after (year)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep buildings built in this year or later, e.g. 1981 for Japan's new earthquake standard. Rentals use SUUMO's age in years. 0 or empty = any."
          },
          "layouts": {
            "title": "Layouts",
            "type": "array",
            "description": "Keep listings whose layout contains one of these, e.g. 1LDK, 2LDK, ワンルーム. Empty = any layout.",
            "items": {
              "type": "string"
            }
          },
          "keywords": {
            "title": "Keywords",
            "type": "array",
            "description": "Keep listings whose name, headline, address, station or agency contains one of these words (Japanese or romaji as SUUMO writes it). Empty = no keyword filter.",
            "items": {
              "type": "string"
            }
          },
          "monitoringMode": {
            "title": "Monitoring mode (new listings and price drops only)",
            "type": "boolean",
            "description": "On: the first run remembers every listing and its price (free); every later run returns only listings that are new or cheaper since the last run, with changeType and previousPriceYen. Off: return the current listings.",
            "default": false
          },
          "resetMonitoringState": {
            "title": "Reset monitoring memory",
            "type": "boolean",
            "description": "On: forget what monitoring remembered for this search, so the next monitoring run starts again from a free baseline. Off: keep the memory.",
            "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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}