{
  "openapi": "3.0.1",
  "info": {
    "title": "Bayutrix — Bayut Scraper | Property, Agency & Broker",
    "description": "**[$0.0008/result]** Scrape Bayut (all countries) for high-value real estate data on properties, agencies, and brokers for lead generation, analysis, and automation. Get unlimited results, no limits!",
    "version": "0.0",
    "x-build-id": "zIYJgxi6N6xenveD1"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/coding-doctor-omar~Bayutrix/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-coding-doctor-omar-Bayutrix",
        "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/coding-doctor-omar~Bayutrix/runs": {
      "post": {
        "operationId": "runs-sync-coding-doctor-omar-Bayutrix",
        "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/coding-doctor-omar~Bayutrix/run-sync": {
      "post": {
        "operationId": "run-sync-coding-doctor-omar-Bayutrix",
        "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",
        "required": [
          "country",
          "scraperModel"
        ],
        "properties": {
          "country": {
            "title": "🌍 Country",
            "enum": [
              "eg",
              "jo",
              "ae",
              "sa",
              "kw",
              "qa",
              "bh",
              "om"
            ],
            "type": "string",
            "description": "The country you want to scrape (e.g. Egypt).",
            "default": "eg"
          },
          "location": {
            "title": "Location",
            "type": "string",
            "description": "The specific location to scrape (for properties only). Bayutrix intelligently guesses what you type, but it is recommended to verify the exact city name from Bayut first.",
            "default": ""
          },
          "scraperModel": {
            "title": "Scraper Model",
            "enum": [
              "propertyLocator",
              "agencyLocator",
              "brokerLocator"
            ],
            "type": "string",
            "description": "The scraper model to use (e.g. 'Property Locator', 'Agency Locator').",
            "default": "propertyLocator"
          },
          "maxResults": {
            "title": "Max Results",
            "type": "integer",
            "description": "Maximum number of results to return. For unlimited results, use 0.",
            "default": 50
          },
          "propertyUrls": {
            "title": "Property URLs",
            "type": "array",
            "description": "The URLs for the specific properties to scrape. If provided, all other property filters will be ingored.",
            "default": [],
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "agencyName": {
            "title": "Agency Name",
            "type": "string",
            "description": "The name of the specific agency for which to look for properties."
          },
          "propertyPurpose": {
            "title": "Property Purpose",
            "enum": [
              "any",
              "for-sale",
              "for-rent"
            ],
            "type": "string",
            "description": "Specifies whether the property is for sale or for rent.",
            "default": "any"
          },
          "propertyRentFrequency": {
            "title": "Rent Frequency",
            "enum": [
              "any",
              "daily",
              "weekly",
              "monthly",
              "yearly"
            ],
            "type": "string",
            "description": "Rent frequency (e.g. Yearly). Only used with 'For Rent' properties.",
            "default": "any"
          },
          "propertyCompletionStatus": {
            "title": "Completion Status",
            "enum": [
              "all",
              "completed",
              "under-construction"
            ],
            "type": "string",
            "description": "Specifies whether the property is ready or off-plan.",
            "default": "all"
          },
          "propertyType": {
            "title": "Property Type",
            "enum": [
              "any",
              "residential",
              "apartments",
              "villas",
              "duplexes",
              "penthouses",
              "chalets",
              "townhouses",
              "twin-houses",
              "rooms",
              "lands",
              "residential-buildings",
              "ivillas",
              "hotel-apartments",
              "cabins",
              "roofs",
              "other-residential-properties",
              "commercial",
              "offices",
              "commercial-buildings",
              "warehouses",
              "clinics",
              "factories",
              "garages",
              "restaurants-and-cafes",
              "retail",
              "agricultural-lands",
              "industrial",
              "commercial-lands",
              "pharmacy",
              "commercial-roofs",
              "medical-facilities",
              "showrooms",
              "co-working-spaces",
              "commercial-properties"
            ],
            "type": "string",
            "description": "Specifies the property type (e.g. Residential Room, Commercial Office, etc).",
            "default": "any"
          },
          "bedrooms": {
            "title": "Number of Bedrooms",
            "enum": [
              "0",
              "1",
              "2",
              "3",
              "4",
              "5",
              "6",
              "7",
              "8+"
            ],
            "type": "string",
            "description": "Number of bedrooms in the property (if applicable)."
          },
          "bathrooms": {
            "title": "Number of Bathrooms",
            "enum": [
              "1",
              "2",
              "3",
              "4",
              "5",
              "6+"
            ],
            "type": "string",
            "description": "Number of bathrooms in the property (if applicable)."
          },
          "minDownPayment": {
            "title": "Minimum Down Payment",
            "type": "integer",
            "description": "Minimum Down Payment.",
            "default": 0
          },
          "maxDownPayment": {
            "title": "Maximum Down Payment",
            "type": "integer",
            "description": "Maximum Down Payment."
          },
          "minPrice": {
            "title": "Minimum Price",
            "type": "integer",
            "description": "Minimum Price.",
            "default": 0
          },
          "maxPrice": {
            "title": "Maximum Price",
            "type": "integer",
            "description": "Maximum Price."
          },
          "minArea": {
            "title": "Minimum Area (square meters)",
            "type": "integer",
            "description": "Minimum Area (in square meters).",
            "default": 0
          },
          "maxArea": {
            "title": "Maximum Area (square meters)",
            "type": "integer",
            "description": "Maximum Area (in square meters)."
          },
          "agencyUrls": {
            "title": "Agency URLs",
            "type": "array",
            "description": "The specific agency URLs to scrape. If not provided, all agencies in your chosen country will be scraped.",
            "default": [],
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "brokerUrls": {
            "title": "Broker URLs",
            "type": "array",
            "description": "The specific broker URLs to scrape. If provided, all other broker filters will be ignored.",
            "default": [],
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "brokerCategory": {
            "title": "Broker Category",
            "enum": [
              "total",
              "residential",
              "commercial"
            ],
            "type": "string",
            "description": "Whether to target residential or commercial brokers.",
            "default": "total"
          },
          "brokerCompletionStatus": {
            "title": "Completion Status",
            "enum": [
              "any",
              "completed",
              "under-construction"
            ],
            "type": "string",
            "description": "Determines the completion status of the brokers' listings (e.g. brokers with listings under construction).",
            "default": "any"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}