{
  "openapi": "3.0.1",
  "info": {
    "title": "Otodom, Storia & Imovirtual Real Estate Scraper",
    "description": "Fast real estate scraper for Otodom.pl (Poland), Storia.ro (Romania) & Imovirtual.com (Portugal). Extracts property prices, price/m², seller phone numbers, GPS coordinates, floor plans, photos & attributes.",
    "version": "1.0",
    "x-build-id": "aHPXFjj7L93QXuh3K"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/gololo~otodom-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-gololo-otodom-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/gololo~otodom-scraper/runs": {
      "post": {
        "operationId": "runs-sync-gololo-otodom-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/gololo~otodom-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-gololo-otodom-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": {
          "searchUrls": {
            "title": "Search or Offer URLs",
            "type": "array",
            "description": "Paste one or more search result URLs or direct property offer URLs from otodom.pl, storia.ro, or imovirtual.com. Leave empty to use the structured filters below.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "country": {
            "title": "Portal / Country (when not using URLs)",
            "enum": [
              "pl",
              "ro",
              "pt"
            ],
            "type": "string",
            "description": "Select which OLX Group real estate portal to query when searchUrls is empty.",
            "default": "pl"
          },
          "transactionType": {
            "title": "Transaction type",
            "enum": [
              "SELL",
              "RENT"
            ],
            "type": "string",
            "description": "Filter by sale (SELL) or rental (RENT) listings when building a search from filters.",
            "default": "SELL"
          },
          "propertyType": {
            "title": "Property type",
            "enum": [
              "FLAT",
              "HOUSE",
              "ROOM",
              "TERRAIN",
              "COMMERCIAL",
              "WAREHOUSE",
              "GARAGE"
            ],
            "type": "string",
            "description": "Select the type of real estate property to search for.",
            "default": "FLAT"
          },
          "locationSlug": {
            "title": "Location path slug (optional)",
            "type": "string",
            "description": "Optional location path slug from the portal URL, e.g. 'mazowieckie/warszawa', 'malopolskie/krakow', 'bucuresti', 'cluj/cluj-napoca', 'lisboa', or 'porto'. Leave empty for nationwide."
          },
          "priceMin": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "integer",
            "description": "Optional minimum total price filter in local currency (PLN or EUR)."
          },
          "priceMax": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "integer",
            "description": "Optional maximum total price filter in local currency (PLN or EUR)."
          },
          "areaMin": {
            "title": "Minimum area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional minimum property surface area in square meters (m²)."
          },
          "areaMax": {
            "title": "Maximum area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional maximum property surface area in square meters (m²)."
          },
          "sellerType": {
            "title": "Seller / Advertiser type",
            "enum": [
              "ALL",
              "PRIVATE",
              "AGENCY",
              "DEVELOPER"
            ],
            "type": "string",
            "description": "Filter by all sellers, private owners only (FSBO / Bezpośrednio), real estate agencies, or developers.",
            "default": "ALL"
          },
          "marketType": {
            "title": "Market type",
            "enum": [
              "ALL",
              "PRIMARY",
              "SECONDARY"
            ],
            "type": "string",
            "description": "Filter by primary market (new builds) or secondary market (resale).",
            "default": "ALL"
          },
          "sortBy": {
            "title": "Sort order",
            "enum": [
              "DEFAULT",
              "LATEST",
              "PRICE_ASC",
              "PRICE_DESC",
              "AREA_DESC"
            ],
            "type": "string",
            "description": "Sort search results by newest first, lowest price, highest price, or largest area.",
            "default": "DEFAULT"
          },
          "maxListings": {
            "title": "Max listings (total)",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Maximum total number of property listings to scrape across the entire run.",
            "default": 100
          },
          "maxListingsPerSearch": {
            "title": "Max listings per search URL",
            "minimum": 0,
            "type": "integer",
            "description": "Optional cap per individual search URL (0 = use total maxListings).",
            "default": 0
          },
          "includeFullDetails": {
            "title": "Include phone numbers, GPS coordinates & full details",
            "type": "boolean",
            "description": "When enabled (recommended), fetches each listing's Next.js data payload to extract seller phone numbers, exact GPS coordinates, full description, floor plans, build year, heating, and equipment.",
            "default": true
          },
          "includeDescription": {
            "title": "Include full plain-text description",
            "type": "boolean",
            "description": "Include the cleaned plain-text property description in each output record.",
            "default": true
          },
          "splitByPrice": {
            "title": "Bypass pagination limits (split by price range)",
            "type": "boolean",
            "description": "Automatically bisect large searches by price range when a query exceeds 3,600 listings.",
            "default": true
          },
          "onlyNewListings": {
            "title": "Only new listings since last run (monitoring mode)",
            "type": "boolean",
            "description": "Deduplicate across runs using a persistent Key-Value Store (otodom-scraper-monitor-state) so scheduled runs only output newly posted properties.",
            "default": false
          },
          "trackPriceChanges": {
            "title": "Track price changes across runs",
            "type": "boolean",
            "description": "Remembers the last seen price of each property across runs and populates previousPrice, priceDelta, and priceChangePercent whenever a seller or agency changes the price.",
            "default": true
          },
          "includePriceDrops": {
            "title": "Include price drops in monitoring mode",
            "type": "boolean",
            "description": "When 'Only new listings since last run' is enabled, also emit previously seen properties if their price dropped since the last run.",
            "default": true
          },
          "skipPromoted": {
            "title": "Skip promoted (paid) listings",
            "type": "boolean",
            "description": "Exclude promoted or highlighted tiles from the output.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional proxy settings. Direct connections work out of the box via TLS fingerprint impersonation.",
            "default": {
              "useApifyProxy": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}