{
  "openapi": "3.0.1",
  "info": {
    "title": "Property Finder Scraper: UAE, Saudi, Qatar, Egypt Listings",
    "description": "Scrape Property Finder listings in the UAE, Saudi Arabia, Qatar, Bahrain and Egypt, buy and rent: price, size, beds, baths, location, agent, agency, phone, permit, listed date, photos and description. Search by place name or paste links. No login.",
    "version": "0.1",
    "x-build-id": "5ABmBPsux9F02Ogbt"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/themineworks~propertyfinder-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-themineworks-propertyfinder-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~propertyfinder-scraper/runs": {
      "post": {
        "operationId": "runs-sync-themineworks-propertyfinder-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~propertyfinder-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-themineworks-propertyfinder-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": {
          "country": {
            "title": "Country",
            "enum": [
              "ae",
              "sa",
              "qa",
              "bh",
              "eg"
            ],
            "type": "string",
            "description": "Which Property Finder site to search with the fields below. Pasted links carry their own country.",
            "default": "ae"
          },
          "purpose": {
            "title": "Buy, rent or new projects",
            "enum": [
              "buy",
              "rent",
              "commercial-buy",
              "commercial-rent",
              "new-projects"
            ],
            "type": "string",
            "description": "Residential for sale, residential for rent, commercial for sale, commercial for rent, or new projects from developers.",
            "default": "buy"
          },
          "locations": {
            "title": "Locations",
            "type": "array",
            "description": "City, community or building names, one per line, for example Dubai Marina, Jumeirah Village Circle, Riyadh, The Pearl Island, Juffair or New Cairo City. Each location is one search, matched to Property Finder's own place list (the summary row shows which place was matched). Leave empty to search the whole country.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Search or listing links (optional)",
            "type": "array",
            "description": "Links copied from your browser: any search results page, for example https://www.propertyfinder.ae/en/rent/dubai/apartments-for-rent-dubai-marina.html or https://www.propertyfinder.sa/en/search?c=1&t=1, or single listing pages (/plp/ links). A link keeps its own filters; the filter fields below apply to the country search only.",
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "Max listings per search",
            "minimum": 1,
            "maximum": 20000,
            "type": "integer",
            "description": "Most listings to return from each search (location or link). Property Finder shows 25 to 30 listings a page.",
            "default": 100
          },
          "propertyType": {
            "title": "Property type",
            "type": "string",
            "description": "One type name as Property Finder shows it, for example apartment, villa, townhouse, penthouse, duplex, land, office space, shop, warehouse, chalet or twin house. Leave empty for all types."
          },
          "bedrooms": {
            "title": "Bedrooms",
            "type": "array",
            "description": "Pick one or more. Studio is 0; 8 means 7 or more.",
            "items": {
              "type": "string",
              "enum": [
                "0",
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8"
              ],
              "enumTitles": [
                "Studio",
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "7+"
              ]
            }
          },
          "bathrooms": {
            "title": "Bathrooms",
            "type": "array",
            "description": "Pick one or more. 7 means 6 or more.",
            "items": {
              "type": "string",
              "enum": [
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7"
              ],
              "enumTitles": [
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "6+"
              ]
            }
          },
          "priceMin": {
            "title": "Min price",
            "minimum": 0,
            "type": "integer",
            "description": "In the local currency (AED, SAR, QAR, BHD or EGP). For rentals, per rent period."
          },
          "priceMax": {
            "title": "Max price",
            "minimum": 0,
            "type": "integer",
            "description": "In the local currency. For rentals, per rent period."
          },
          "rentPeriod": {
            "title": "Rent period",
            "enum": [
              "yearly",
              "monthly",
              "weekly",
              "daily"
            ],
            "type": "string",
            "description": "For rentals: the period the price filter and results use. Leave empty for any."
          },
          "areaMin": {
            "title": "Min size",
            "minimum": 0,
            "type": "integer",
            "description": "In the unit the site uses for that country (square feet on propertyfinder.ae, square metres on the others)."
          },
          "areaMax": {
            "title": "Max size",
            "minimum": 0,
            "type": "integer",
            "description": "In the unit the site uses for that country."
          },
          "furnishing": {
            "title": "Furnishing",
            "enum": [
              "any",
              "furnished",
              "unfurnished",
              "partly"
            ],
            "type": "string",
            "description": "Furnished, unfurnished or partly furnished.",
            "default": "any"
          },
          "completion": {
            "title": "Ready or off plan",
            "enum": [
              "completed",
              "off_plan"
            ],
            "type": "string",
            "description": "For sales: ready (completed) or off plan. Leave empty for both."
          },
          "keywords": {
            "title": "Keywords",
            "type": "string",
            "description": "Words that must appear in the listing, for example sea view or private pool."
          },
          "listedWithinDays": {
            "title": "Listed within",
            "enum": [
              "1",
              "7",
              "15",
              "30",
              "90"
            ],
            "type": "string",
            "description": "Only listings added in the last 1, 7, 15, 30 or 90 days. Use with sort by newest for daily monitoring."
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "newest",
              "featured",
              "price_low",
              "price_high",
              "beds_low",
              "beds_high"
            ],
            "type": "string",
            "description": "Order of the results.",
            "default": "newest"
          },
          "includeDetails": {
            "title": "Open each listing page",
            "type": "boolean",
            "description": "Also open every listing's own page for the full photo set (search pages show 4), licence numbers, the agent's position, experience and listing count, the agency's licence number and size, and the rental availability date. Slower; same price per listing.",
            "default": false
          },
          "includeNewProjects": {
            "title": "Include new project cards",
            "type": "boolean",
            "description": "Buy searches mix developer project cards (developer, delivery date, starting price, payment plan) in with listings. Off returns listings only.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Requests go out directly first and move to this proxy only if Property Finder refuses them. Apify datacenter proxy is enough.",
            "default": {
              "useApifyProxy": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}