{
  "openapi": "3.0.1",
  "info": {
    "title": "Czech Real Estate Aggregator: Sreality, Bezrealitky & iDNES",
    "description": "All big Czech property portals in one run: Sreality.cz, Bezrealitky.cz and iDNES Reality. One row per property with duplicates merged, price per m² vs. the district median, monitoring of new and changed listings, market summary, notifications. Unofficial.",
    "version": "0.0",
    "x-build-id": "dBAccY4zn1OMRqUf6"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tsutseisoftware~czech-real-estate-aggregator/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tsutseisoftware-czech-real-estate-aggregator",
        "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/tsutseisoftware~czech-real-estate-aggregator/runs": {
      "post": {
        "operationId": "runs-sync-tsutseisoftware-czech-real-estate-aggregator",
        "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/tsutseisoftware~czech-real-estate-aggregator/run-sync": {
      "post": {
        "operationId": "run-sync-tsutseisoftware-czech-real-estate-aggregator",
        "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": {
          "sources": {
            "title": "Portals",
            "type": "array",
            "description": "Portals to read, one after another. A property found on several portals is one row and pays the price of its cheapest portal once. Proxies are set by default and included in the price.",
            "items": {
              "type": "string",
              "enum": [
                "sreality",
                "bezrealitky",
                "idnes"
              ],
              "enumTitles": [
                "Sreality.cz ($0.79 / 1 000)",
                "Bezrealitky.cz ($1.30 / 1 000)",
                "iDNES Reality ($3.80 / 1 000)"
              ]
            },
            "default": [
              "sreality",
              "bezrealitky",
              "idnes"
            ]
          },
          "transactionType": {
            "title": "Transaction",
            "enum": [
              "sale",
              "rent",
              "auction"
            ],
            "type": "string",
            "description": "Sale, rent or auction. Bezrealitky.cz has no auctions (it is skipped for them).",
            "default": "sale"
          },
          "propertyTypes": {
            "title": "Property types",
            "type": "array",
            "description": "Empty = flats. On Bezrealitky.cz houses include cottages, commercial means offices and commercial spaces, and other means garages.",
            "items": {
              "type": "string",
              "enum": [
                "flat",
                "house",
                "land",
                "commercial",
                "other"
              ],
              "enumTitles": [
                "Flats (Byty)",
                "Houses (Domy)",
                "Land (Pozemky)",
                "Commercial (Komerční)",
                "Garages and other (Garáže a ostatní)"
              ]
            }
          },
          "subtypes": {
            "title": "Layouts and kinds",
            "type": "array",
            "description": "Flat layouts as the portals name them: 1+kk, 1+1, 2+kk, 2+1, 3+kk, 3+1, 4+kk, 4+1, 5+kk, 5+1, \"6 a více\". Kinds of houses and land are named differently on each portal; a portal that does not know a value reports it and is skipped.",
            "items": {
              "type": "string"
            }
          },
          "locations": {
            "title": "Locations",
            "type": "array",
            "description": "Towns, city parts or streets in words (e.g. \"Brno\", \"Praha 6\", \"Smíchov\"), looked up like each portal's search box. At most 10.",
            "items": {
              "type": "string"
            }
          },
          "radiusKm": {
            "title": "Radius around locations (km)",
            "minimum": 0,
            "maximum": 50,
            "type": "integer",
            "description": "Also listings up to this distance around each location (iDNES Reality rounds up to 0.5, 1, 5, 10 or 20 km). 0 = only the location itself."
          },
          "regions": {
            "title": "Regions (kraje)",
            "type": "array",
            "description": "Whole regions. Empty (with no locations or districts) = the whole country.",
            "items": {
              "type": "string",
              "enum": [
                "praha",
                "stredocesky-kraj",
                "jihocesky-kraj",
                "plzensky-kraj",
                "karlovarsky-kraj",
                "ustecky-kraj",
                "liberecky-kraj",
                "kralovehradecky-kraj",
                "pardubicky-kraj",
                "kraj-vysocina",
                "jihomoravsky-kraj",
                "olomoucky-kraj",
                "zlinsky-kraj",
                "moravskoslezsky-kraj"
              ],
              "enumTitles": [
                "Praha",
                "Středočeský",
                "Jihočeský",
                "Plzeňský",
                "Karlovarský",
                "Ústecký",
                "Liberecký",
                "Královéhradecký",
                "Pardubický",
                "Vysočina",
                "Jihomoravský",
                "Olomoucký",
                "Zlínský",
                "Moravskoslezský"
              ]
            }
          },
          "districts": {
            "title": "Districts (okresy)",
            "type": "array",
            "description": "Districts by name, e.g. \"Brno-město\", \"Praha-západ\", \"Kladno\".",
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "Max listings",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of properties saved (after merging duplicates). 0 = no limit.",
            "default": 200
          },
          "maxItemsPerSource": {
            "title": "Max listings per portal",
            "minimum": 0,
            "type": "integer",
            "description": "How many listings each portal reads at most. 0 = its share of \"Max listings\" (Max listings ÷ number of portals + 20 %).",
            "default": 0
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "newest",
              "priceAsc",
              "priceDesc"
            ],
            "type": "string",
            "description": "Order of the results on each portal (which listings are read first when a limit stops the run).",
            "default": "newest"
          },
          "minPrice": {
            "title": "Min price (CZK)",
            "minimum": 0,
            "type": "integer",
            "description": "For rentals the monthly rent."
          },
          "maxPrice": {
            "title": "Max price (CZK)",
            "minimum": 0,
            "type": "integer",
            "description": "For rentals the monthly rent."
          },
          "minArea": {
            "title": "Min usable area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Usable area."
          },
          "maxArea": {
            "title": "Max usable area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Usable area."
          },
          "minPlotArea": {
            "title": "Min plot area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Houses and land."
          },
          "maxPlotArea": {
            "title": "Max plot area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Houses and land."
          },
          "minPricePerSqm": {
            "title": "Min price per m²",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings with at least this price per m² (rentals: monthly rent per m²)."
          },
          "maxPricePerSqm": {
            "title": "Max price per m²",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings with at most this price per m² (finds bargains)."
          },
          "minFloor": {
            "title": "Min floor",
            "minimum": -5,
            "type": "integer",
            "description": "Flats on this floor or higher (0 = ground floor). Not available on iDNES Reality (read without it)."
          },
          "maxFloor": {
            "title": "Max floor",
            "minimum": -5,
            "type": "integer",
            "description": "Flats on this floor or lower. Not available on iDNES Reality (read without it)."
          },
          "maxAgeDays": {
            "title": "Listed within days",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings published in this many days. Bezrealitky.cz has no such filter (read without it). Empty = any age."
          },
          "features": {
            "title": "Features",
            "type": "array",
            "description": "Only listings with these features (each portal's own filter).",
            "items": {
              "type": "string",
              "enum": [
                "balcony",
                "terrace",
                "loggia",
                "cellar",
                "garage",
                "parking",
                "elevator",
                "barrierFree",
                "garden"
              ],
              "enumTitles": [
                "Balcony",
                "Terrace",
                "Loggia",
                "Cellar",
                "Garage",
                "Parking",
                "Elevator",
                "Barrier-free",
                "Garden"
              ]
            }
          },
          "furnished": {
            "title": "Furnished",
            "type": "array",
            "description": "Furnishing (mostly for rentals).",
            "items": {
              "type": "string",
              "enum": [
                "yes",
                "no",
                "partly"
              ],
              "enumTitles": [
                "Furnished",
                "Unfurnished",
                "Partly furnished"
              ]
            }
          },
          "energyClasses": {
            "title": "Energy classes (PENB)",
            "type": "array",
            "description": "Only these energy classes. Not available on iDNES Reality (read without it).",
            "items": {
              "type": "string",
              "enum": [
                "A",
                "B",
                "C",
                "D",
                "E",
                "F",
                "G"
              ]
            }
          },
          "sellerType": {
            "title": "Seller",
            "enum": [
              "any",
              "agency",
              "private"
            ],
            "type": "string",
            "description": "On Bezrealitky.cz (private owners) \"Agencies only\" means its partners and developer projects.",
            "default": "any"
          },
          "onlyDiscounted": {
            "title": "Only discounted",
            "type": "boolean",
            "description": "Only listings marked as discounted (Zlevněno).",
            "default": false
          },
          "onlyWithPrice": {
            "title": "Only with price",
            "type": "boolean",
            "description": "Skip listings with the price on request.",
            "default": false
          },
          "onlyWithGps": {
            "title": "Only with GPS",
            "type": "boolean",
            "description": "Skip listings without coordinates (on iDNES Reality GPS comes with \"Add listing details\").",
            "default": false
          },
          "onlyWithImages": {
            "title": "Only with photos",
            "type": "boolean",
            "description": "Skip listings without photos.",
            "default": false
          },
          "descriptionContains": {
            "title": "Text contains",
            "type": "string",
            "description": "Full-text search in titles and descriptions (e.g. \"sauna\", \"výhled\")."
          },
          "excludeKeywords": {
            "title": "Exclude words",
            "type": "array",
            "description": "Skip listings whose title (or description, with details) contains any of these words, e.g. \"podíl\".",
            "items": {
              "type": "string"
            }
          },
          "includeDetails": {
            "title": "Add listing details",
            "type": "boolean",
            "description": "Read each listing's page too: description, all parameters (floor, condition, ownership, energy class, balcony…), GPS on iDNES Reality. Slower and paid per listing with its page read (the price of the portal's own actor, see the README).",
            "default": false
          },
          "mergeDuplicates": {
            "title": "Merge duplicates across portals",
            "type": "boolean",
            "description": "One row per property when the same property is on several portals, with all its portals and links in \"portals\" and \"sources\". Merging is strict, so two different properties are never joined. Off = one row per listing.",
            "default": true
          },
          "includeRentalYield": {
            "title": "Add rental yield (flats for sale)",
            "type": "boolean",
            "description": "Also reads flats for rent in the same places and adds to each flat for sale an estimated monthly rent from comparable rentals of the same run and the gross rental yield. An estimate from asking prices, without taxes, vacancy or service charges; null where the run finds too few comparable rentals. $0.50 per 1 000 flats with a yield, plus $0.02 per 1 000 rentals read.",
            "default": false
          },
          "rentalSampleSize": {
            "title": "Rental yield: rentals to read",
            "minimum": 20,
            "maximum": 3000,
            "type": "integer",
            "description": "How many flats for rent are read for the medians (shared by the portals). More rentals = more districts and layouts with a yield.",
            "default": 300
          },
          "compactOutput": {
            "title": "Compact output",
            "type": "boolean",
            "description": "Only the core fields (id, portals, URL, name, type, layout, price, price per m², area, place, GPS, seller, price vs. district), plus the description and the monitoring fields when those are on. Smaller rows for AI agents, MCP clients and spreadsheets.",
            "default": false
          },
          "onlyNewOrChanged": {
            "title": "Monitoring: only new or changed listings",
            "type": "boolean",
            "description": "Return only properties that are new or whose price, name, portals, discount or reservation changed since the previous run with the same Monitoring key. Unchanged properties are not saved and pay only a small check fee ($0.02 per 1 000, see the README).",
            "default": false
          },
          "monitoringKey": {
            "title": "Monitoring: key",
            "type": "string",
            "description": "Name of the remembered state; use a different key for each search you monitor."
          },
          "telegramBotToken": {
            "title": "Notifications: Telegram bot token",
            "type": "string",
            "description": "Token of your Telegram bot (from @BotFather). Used with \"Telegram chat ID\"."
          },
          "telegramChatId": {
            "title": "Notifications: Telegram chat ID",
            "type": "string",
            "description": "Chat, group or channel ID the bot writes to (e.g. -1001234567890)."
          },
          "slackWebhookUrl": {
            "title": "Notifications: Slack webhook URL",
            "type": "string",
            "description": "Incoming webhook of your Slack channel (https://hooks.slack.com/services/...)."
          },
          "discordWebhookUrl": {
            "title": "Notifications: Discord webhook URL",
            "type": "string",
            "description": "Webhook of your Discord channel (https://discord.com/api/webhooks/...). In Discord: channel settings → Integrations → Webhooks → Copy Webhook URL. Stored encrypted."
          },
          "webhookUrl": {
            "title": "Notifications: webhook URL",
            "type": "string",
            "description": "Any HTTPS URL: gets a POST with JSON {title, summary, totalSaved, runUrl, datasetUrl, items}."
          },
          "whatsappAccessToken": {
            "title": "Notifications: WhatsApp access token",
            "type": "string",
            "description": "Access token of the WhatsApp Cloud API of your Meta business account, used with \"WhatsApp phone number ID\" and \"WhatsApp recipient number\" (step by step in the README, section \"WhatsApp notifications: setup\"). For scheduled runs use a permanent token of a system user: Business settings → System users → Generate token, with the permissions whatsapp_business_messaging and whatsapp_business_management; the token of WhatsApp → API Setup expires within hours. Stored encrypted."
          },
          "whatsappPhoneNumberId": {
            "title": "Notifications: WhatsApp phone number ID",
            "type": "string",
            "description": "ID of your WhatsApp business number that sends the message (not the number itself), e.g. 106540352242922. In your Meta app: WhatsApp → API Setup → Phone number ID."
          },
          "whatsappTo": {
            "title": "Notifications: WhatsApp recipient number",
            "type": "string",
            "description": "Phone number that gets the message, in international format with the country code (e.g. +420601234567); up to 5 numbers separated by commas or new lines, each gets its own message and the notification is charged once per run. A test number of Meta sends only to numbers you added and confirmed under API Setup → To. Stored encrypted."
          },
          "whatsappTemplateName": {
            "title": "Notifications: WhatsApp template name",
            "type": "string",
            "description": "Name of your approved message template (WhatsApp Manager → Message templates, e.g. apify_results), recommended: WhatsApp delivers a template message at any time. Its body gets the run summary with the first results in {{1}} and the dataset link in {{2}} (a template with only {{1}} gets both in {{1}}). Empty: a plain text message, which WhatsApp delivers only when the recipient wrote to your business number in the last 24 hours, so a scheduled run usually needs a template. Meta charges your business account for template messages (step by step in the README, section \"WhatsApp notifications: setup\")."
          },
          "whatsappTemplateLanguage": {
            "title": "Notifications: WhatsApp template language",
            "type": "string",
            "description": "Language code of the template exactly as WhatsApp Manager → Message templates shows it next to the template, e.g. en_US, en_GB, cs, sk, pl or de. Used only with \"WhatsApp template name\".",
            "default": "en_US"
          },
          "notificationLimit": {
            "title": "Notifications: max listings per message",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many properties are listed in one notification (the rest as \"…and N more\").",
            "default": 10
          },
          "notifyOnlyChanges": {
            "title": "Notifications: only when something was saved",
            "type": "boolean",
            "description": "Send nothing when the run saved no property (e.g. a monitoring run without new listings).",
            "default": true
          },
          "sendErrorReports": {
            "title": "Send error reports",
            "type": "boolean",
            "description": "When a run fails, send the developer a short error report: the error and your input with secrets left out (tokens, webhooks and e-mails are hidden). Your results are never sent. Reports are deleted after at most 120 hours. Turn off to send nothing.",
            "default": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}