{
  "openapi": "3.0.1",
  "info": {
    "title": "Otodom Scraper: Otomoto, OLX, Imovirtual and Storia Listings",
    "description": "Scrape Otodom, Otomoto, OLX (PL, PT, RO, BG, UA), Imovirtual, Standvirtual, Storia and Autovit: one row per listing with price, area or mileage, rooms, year, location, seller type and agency or dealer. Paste search links or pick a place. No login.",
    "version": "0.1",
    "x-build-id": "PxM3Sz3tF5T76zJON"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/themineworks~otodom-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-themineworks-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/themineworks~otodom-scraper/runs": {
      "post": {
        "operationId": "runs-sync-themineworks-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/themineworks~otodom-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-themineworks-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": {
          "site": {
            "title": "Site",
            "enum": [
              "otodom.pl",
              "otomoto.pl",
              "olx.pl",
              "imovirtual.com",
              "standvirtual.com",
              "olx.pt",
              "storia.ro",
              "autovit.ro",
              "olx.ro",
              "olx.bg",
              "olx.ua"
            ],
            "type": "string",
            "description": "The site to search with the fields below. Ignored for links in startUrls (each link names its own site).",
            "default": "otodom.pl"
          },
          "locations": {
            "title": "Places",
            "type": "array",
            "description": "City or region names, one per line, as the site spells them (Warszawa, Kraków, Lisboa, Porto, Bucuresti, Sofia). Each place is one search. Leave empty to search the whole country. On Otodom, Imovirtual and Storia you can also give the site's own location path, for example mazowieckie/warszawa/warszawa/warszawa.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Search links (optional, replaces the fields)",
            "type": "array",
            "description": "Search results links copied from your browser on any of the 11 sites, with every filter you set there. Example: https://www.otodom.pl/pl/wyniki/wynajem/mieszkanie/malopolskie/krakow/krakow/krakow?priceMax=4000 or https://www.otomoto.pl/osobowe/toyota/corolla or https://www.olx.pl/nieruchomosci/mieszkania/warszawa/. When links are given, the site, places and filter fields are not used.",
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "Max listings per search",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "The most listings to return for each place or link, 1 to 10,000. OLX serves the first 1,000 results of any one search.",
            "default": 100
          },
          "sort": {
            "title": "Sort by",
            "enum": [
              "default",
              "newest",
              "price_low",
              "price_high"
            ],
            "type": "string",
            "description": "Order of the results. Default keeps the site's own order.",
            "default": "default"
          },
          "transaction": {
            "title": "Sale or rent (property sites)",
            "enum": [
              "sale",
              "rent"
            ],
            "type": "string",
            "description": "For Otodom, Imovirtual and Storia.",
            "default": "sale"
          },
          "propertyType": {
            "title": "Property type",
            "enum": [
              "flat",
              "house",
              "plot",
              "commercial",
              "room",
              "garage",
              "warehouse",
              "investment"
            ],
            "type": "string",
            "description": "Flat, house, plot, commercial, room, garage, warehouse or new development. Not every site has every type: Imovirtual has no commercial or warehouse search, Storia no warehouse or development search (paste a link instead).",
            "default": "flat"
          },
          "areaMin": {
            "title": "Area from (m2)",
            "minimum": 0,
            "type": "integer",
            "description": "Smallest floor area in square metres."
          },
          "areaMax": {
            "title": "Area to (m2)",
            "minimum": 0,
            "type": "integer",
            "description": "Largest floor area in square metres."
          },
          "rooms": {
            "title": "Rooms",
            "type": "array",
            "description": "Room counts to include, for example 2 and 3. 10 means 10 or more.",
            "items": {
              "type": "string"
            }
          },
          "ownerType": {
            "title": "Listed by",
            "enum": [
              "all",
              "private",
              "agency"
            ],
            "type": "string",
            "description": "Private owners only, agencies only, or both.",
            "default": "all"
          },
          "market": {
            "title": "Market",
            "enum": [
              "all",
              "primary",
              "secondary"
            ],
            "type": "string",
            "description": "Primary (new from developers) or secondary market.",
            "default": "all"
          },
          "daysSinceCreated": {
            "title": "Listed in the last N days",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Only listings added in the last 1, 3, 7, 14 or 30 days."
          },
          "includeDetails": {
            "title": "Add listing details (property sites)",
            "type": "boolean",
            "description": "On: every property listing also gets its ad data: GPS coordinates, full description, market, build year, building type and material, floors, condition, ownership, heating, windows, amenities and the date it is free from. One extra small request per listing; same price per listing.",
            "default": false
          },
          "vehicleType": {
            "title": "Vehicle type (car sites)",
            "enum": [
              "cars",
              "motorcycles",
              "vans"
            ],
            "type": "string",
            "description": "For Otomoto, Standvirtual and Autovit. Vans are on Otomoto only; for other categories paste a link.",
            "default": "cars"
          },
          "make": {
            "title": "Make",
            "type": "string",
            "description": "For example Toyota, BMW, Dacia."
          },
          "model": {
            "title": "Model",
            "type": "string",
            "description": "For example Corolla. Needs a make."
          },
          "yearFrom": {
            "title": "Year from",
            "minimum": 1900,
            "type": "integer",
            "description": "Oldest production year."
          },
          "yearTo": {
            "title": "Year to",
            "minimum": 1900,
            "type": "integer",
            "description": "Newest production year."
          },
          "mileageMax": {
            "title": "Mileage up to (km)",
            "minimum": 0,
            "type": "integer",
            "description": "Highest mileage in kilometres."
          },
          "radiusKm": {
            "title": "Distance from the place (km)",
            "minimum": 0,
            "maximum": 500,
            "type": "integer",
            "description": "With a place: also include listings within this many kilometres of it."
          },
          "keyword": {
            "title": "Keyword (OLX)",
            "type": "string",
            "description": "Words to search for on OLX, for example iphone 13 or rower. With a place, the search is limited to it."
          },
          "priceMin": {
            "title": "Price from",
            "minimum": 0,
            "type": "integer",
            "description": "Lowest price in the site's currency (PLN in Poland, EUR in Portugal and on Storia and Autovit, RON or EUR on OLX Romania, BGN in Bulgaria, UAH in Ukraine)."
          },
          "priceMax": {
            "title": "Price to",
            "minimum": 0,
            "type": "integer",
            "description": "Highest price in the site's currency."
          },
          "proxyConfiguration": {
            "title": "Proxy (optional)",
            "type": "object",
            "description": "Leave empty: the actor goes direct first, then over Apify datacenter IPs, then a residential IP in the site's country, only when a site refuses a request. Set your own proxy only if you need to."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}