{
  "openapi": "3.0.1",
  "info": {
    "title": "Property Finder Scraper — UAE, Saudi, Qatar Property Data & API",
    "description": "Property Finder scraper & real estate data API for the UAE's leading property portal. Sale & rent listings across Dubai, Abu Dhabi & Sharjah: price, size, beds, baths, GPS, photos, agent email, phone & WhatsApp, RERA permits, amenities & 1-year price trends — clean JSON/CSV.",
    "version": "1.0",
    "x-build-id": "fMreM4nooShq4SjZg"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~propertyfinder-property-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-propertyfinder-property-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/sian.agency~propertyfinder-property-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-propertyfinder-property-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/sian.agency~propertyfinder-property-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-propertyfinder-property-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": {
          "mode": {
            "title": "🧭 Mode",
            "enum": [
              "searchByLocation",
              "searchByCoordinates",
              "searchByUrl",
              "propertyDetails"
            ],
            "type": "string",
            "description": "🎯 **WHAT TO SCRAPE:**\n\n- **Search by location** — free-text location (city, community, or tower), e.g. `Dubai Marina`\n- **Search by coordinates** — GPS point + radius in km\n- **Search by URL** — paste full search URLs with all your filters already applied\n- **Property details** — full dossiers for specific property ids or listing URLs (agent contacts, RERA licenses, amenities, price trends)",
            "default": "searchByLocation"
          },
          "location": {
            "title": "📍 Location (searchByLocation)",
            "type": "string",
            "description": "📍 **LOCATION SEARCH:** city, community, sub-community, or tower name — resolved automatically.\n\n💡 **Examples:** `Dubai`, `Dubai Marina`, `Downtown Dubai`, `Palm Jumeirah`, `Business Bay`, `Al Reem Island`\n\n🇦🇪 Covers the UAE: Dubai, Abu Dhabi, Sharjah, Ajman, Ras Al Khaimah & more.",
            "default": "Dubai Marina"
          },
          "latitude": {
            "title": "🗺 Latitude (searchByCoordinates)",
            "type": "string",
            "description": "🗺 **GPS RADIUS SEARCH:** decimal latitude of the circle center, e.g. `25.0784` (Dubai Marina)."
          },
          "longitude": {
            "title": "🗺 Longitude (searchByCoordinates)",
            "type": "string",
            "description": "🗺 Decimal longitude of the circle center, e.g. `55.1404` (Dubai Marina)."
          },
          "radiusKm": {
            "title": "📏 Radius in km (searchByCoordinates)",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "📏 Search radius around the GPS point in kilometres (1–100).",
            "default": 5
          },
          "searchUrls": {
            "title": "🔗 Search URLs (searchByUrl)",
            "uniqueItems": true,
            "type": "array",
            "description": "🔗 **PASTED SEARCH URLS:** run saved searches exactly as configured on the site — every filter in the URL is honored.\n\n💡 **How to get one:** open the property search, set your filters, copy the address bar URL, paste it here.\n\n🇦🇪 Only UAE search URLs (propertyfinder.ae) are supported.\n\n📋 **BULK EDIT:** Click \"Bulk edit\" to paste URLs (one per line)",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "propertyIds": {
            "title": "🔢 Property IDs (propertyDetails)",
            "uniqueItems": true,
            "type": "array",
            "description": "🔢 **FULL DOSSIERS BY ID:** numeric property ids, e.g. `119736715` — harvest them with any search mode first (the `propertyId` column).\n\n📑 Each dossier adds description, amenities, agent email/phone/WhatsApp, RERA broker & agent licenses, service charges, floor plans, and a 1-year price-trend series.",
            "items": {
              "type": "string"
            }
          },
          "propertyUrls": {
            "title": "🔗 Listing URLs (propertyDetails)",
            "uniqueItems": true,
            "type": "array",
            "description": "🔗 **FULL DOSSIERS BY URL:** paste listing page URLs, e.g. `https://www.propertyfinder.ae/en/plp/buy/...-119736715.html`.\n\n🇦🇪 Only UAE listing URLs (propertyfinder.ae) are supported.\n\n📋 **BULK EDIT:** Click \"Bulk edit\" to paste URLs (one per line)",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "searchType": {
            "title": "🏷 Listing type",
            "enum": [
              "For_Sale",
              "For_Rent"
            ],
            "type": "string",
            "description": "🏷 Buy or rent listings (search modes).",
            "default": "For_Sale"
          },
          "commercial": {
            "title": "🏢 Commercial property",
            "type": "boolean",
            "description": "🏢 Search commercial property (offices, retail, warehouses) instead of residential.",
            "default": false
          },
          "propertyTypes": {
            "title": "🏠 Property types",
            "uniqueItems": true,
            "type": "array",
            "description": "🏠 Filter to one or more types: `Apartment`, `Villa`, `Townhouse`, `Penthouse`, `Compound`, `Duplex`, `Full Floor`, `Half Floor`, `Whole Building`, `Land`, `Bulk Sale Unit`, `Bungalow`, `Hotel Apartment`.",
            "items": {
              "type": "string"
            }
          },
          "minPrice": {
            "title": "💵 Min price (AED)",
            "minimum": 1,
            "type": "integer",
            "description": "💵 Minimum price in AED."
          },
          "maxPrice": {
            "title": "💵 Max price (AED)",
            "minimum": 1,
            "type": "integer",
            "description": "💵 Maximum price in AED."
          },
          "minArea": {
            "title": "📐 Min area (sqft)",
            "minimum": 1,
            "type": "integer",
            "description": "📐 Minimum property size in square feet."
          },
          "maxArea": {
            "title": "📐 Max area (sqft)",
            "minimum": 1,
            "type": "integer",
            "description": "📐 Maximum property size in square feet."
          },
          "bedrooms": {
            "title": "🛏 Bedrooms",
            "uniqueItems": true,
            "type": "array",
            "description": "🛏 Bedroom counts, e.g. `2`, `3`. Use `0` or `studio` for studios; `8` means 7+.",
            "items": {
              "type": "string"
            }
          },
          "bathrooms": {
            "title": "🛁 Bathrooms",
            "uniqueItems": true,
            "type": "array",
            "description": "🛁 Bathroom counts, e.g. `2`, `3`.",
            "items": {
              "type": "string"
            }
          },
          "furnishing": {
            "title": "🛋 Furnishing",
            "enum": [
              "All",
              "Furnished",
              "Unfurnished",
              "Partly_Furnished"
            ],
            "type": "string",
            "description": "🛋 Furnishing status filter.",
            "default": "All"
          },
          "completionStatus": {
            "title": "🚧 Completion status",
            "enum": [
              "Any",
              "Off_Plan",
              "Ready"
            ],
            "type": "string",
            "description": "🚧 `Ready` (built) or `Off_Plan` (under construction).",
            "default": "Any"
          },
          "rentFrequency": {
            "title": "📅 Rent frequency",
            "enum": [
              "Yearly",
              "Monthly",
              "Weekly",
              "Daily"
            ],
            "type": "string",
            "description": "📅 Rent period — only applies when listing type is **For rent**."
          },
          "verifiedOnly": {
            "title": "✅ Verified listings only",
            "type": "boolean",
            "description": "✅ Only listings verified by the portal.",
            "default": false
          },
          "amenities": {
            "title": "🏊 Amenities",
            "uniqueItems": true,
            "type": "array",
            "description": "🏊 Amenity filters, e.g. `Shared Pool`, `Balcony`, `Covered Parking`, `Maids Room`.",
            "items": {
              "type": "string"
            }
          },
          "keywords": {
            "title": "🔍 Keywords",
            "type": "string",
            "description": "🔍 Free-text keyword filter (matches listing title / description), e.g. `sea view`."
          },
          "sortOrder": {
            "title": "↕️ Sort order",
            "enum": [
              "Featured",
              "Newest",
              "Price_Low_to_High",
              "Price_High_to_Low",
              "Beds_Least",
              "Beds_Most",
              "Delivery_Date_Earliest",
              "Delivery_Date_Latest"
            ],
            "type": "string",
            "description": "↕️ Result ordering. Default is the portal's featured ranking."
          },
          "maxResults": {
            "title": "🔢 Max results per query",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "🔢 **RESULT CAP:** stop after this many listings per query (1–5000).\n\n💡 **TIP:** Lower values run faster and cost less.\n\n🎁 **TIER LIMITS:** FREE runs are capped at 1 query and 25 listings; PAID runs are unlimited.",
            "default": 50
          },
          "fetchPropertyDetails": {
            "title": "✨ Fetch full details per listing (PAID)",
            "type": "boolean",
            "description": "✨ **DETAIL ENRICHMENT:** for every search result, also fetch the full dossier — description, amenities, agent email/phone/WhatsApp, RERA broker & agent licenses, service charges, floor plans, and the 1-year price-trend series.\n\n💰 Adds one detail-listing charge per enriched row.\n\n🎁 Available on PAID runs only.",
            "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}