{ "openapi": "3.0.1", "info": { "title": "Aqarmap KSA Property Scraper", "description": "Collect structured public property listing records from sa.aqar.fm through CleanedWeb. Start with a search location and an optional result limit. Records are saved to the default dataset for review, export, and downstream workflows.", "version": "0.1", "x-build-id": "6BeOuRYi6mLdaRfH8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fatihtahta~aqarmap-saudi-arabia-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fatihtahta-aqarmap-saudi-arabia-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/fatihtahta~aqarmap-saudi-arabia-property-scraper/runs": { "post": { "operationId": "runs-sync-fatihtahta-aqarmap-saudi-arabia-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/fatihtahta~aqarmap-saudi-arabia-property-scraper/run-sync": { "post": { "operationId": "run-sync-fatihtahta-aqarmap-saudi-arabia-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": { "property_type": { "title": "Property type", "enum": [ "all", "apartment_for_rent", "land_for_sale", "villa_for_sale", "big_flat_for_rent", "villa_for_rent", "apartment_for_sale", "building_for_sale", "store_for_rent", "small_house_for_sale", "lounge_for_sale", "small_house_for_rent", "farm_for_sale", "lounge_for_rent", "office_for_rent", "land_for_rent", "building_for_rent", "warehouse_for_rent", "tent_for_rent", "room_for_rent", "store_for_sale", "flat_for_sale", "chalet_for_rent", "apartments_for_booking", "villas_for_booking", "studios_for_booking", "chalets_for_booking", "tents_for_booking", "farms_for_booking", "halls_for_booking", "warehouses_for_sale", "kiosks_for_sale", "kiosks_for_rent", "cinemas_for_sale", "cinemas_for_rent", "parking_for_sale", "parking_for_rent", "banks_atms_for_sale", "banks_atms_for_rent", "factories_for_sale", "factories_for_rent", "hospitals_health_centers_for_sale", "hospitals_health_centers_for_rent", "power_stations_for_sale", "power_stations_for_rent", "communication_towers_for_sale", "communication_towers_for_rent", "rooms_for_sale", "complexes_for_sale", "complexes_for_rent", "towers_for_sale", "towers_for_rent", "offices_for_sale", "hotels_for_sale", "hotels_for_rent", "workshops_for_sale", "workshops_for_rent", "schools_for_sale", "schools_for_rent", "stations_for_sale", "stations_for_rent", "farms_for_rent" ], "type": "string", "description": "Choose exactly one target-supported sale, rent, or booking category.", "default": "all" }, "location_city": { "title": "City", "enum": [ "riyadh", "jeddah", "dammam", "al-khobar", "medina", "mecca", "buraydah", "abha", "al-hofuf", "taif", "jazan", "khamis-mushait", "al-muzahimiyah", "al-kharj", "unayzah", "hail", "dhahran", "al-bukayriyah", "ad-diriyah", "al-jubail", "al-majmaah", "tabuk", "hafr-al-batin", "thadiq", "shaqra", "ahad-rufaidah", "al-bahah", "thuwal", "al-quwaiiyah", "abu-arish", "riyadh-al-khabra", "az-zulfi", "buqayq", "al-badayea", "king-abdullah-economic-city", "al-duwadimi", "ar-rass", "al-henakiyah", "muhayil", "arar", "safwa", "rabigh", "nairyah", "al-hayathem", "almajaridah", "baqaa", "al-qunfudhah", "baish", "an-nabhaniyah", "sabya", "alshinana", "howtat-bani-tamim", "al-mithnab", "al-ghazalah", "najran", "saihat", "khafji", "al-ghat", "bisha", "al-jumum", "yanbu", "turbah", "sakaka", "ad-dilam", "rumah", "al-qatif", "ahad-al-masarihah", "ash-shimasiyah", "afif", "samtah", "ras-tanura", "billasmar", "dumah-al-jandal", "al-lith", "tayma", "al-ula", "tarout", "as-sulayyil", "al-kamil", "mahd-adh-dhahab", "sharorah", "al-`uyun", "al-hariq", "duba", "tathleeth", "rafha", "ranyah", "al-wajh", "anak", "umluj", "al-khurma", "al-qurayyat", "turaif", "badr", "khaybar" ], "type": "string", "description": "Select the city used as the first location level." }, "location_direction": { "title": "Direction or City Area", "type": "string", "description": "For Riyadh or Jeddah, enter a source direction such as South of Riyadh. Leave empty for a city-wide search." }, "location_district": { "title": "District", "type": "string", "description": "Enter the district name as shown by Aqar, such as Badr or Ar Rihab." }, "family_type": { "title": "Tenant category", "enum": [ "single", "family" ], "type": "string", "description": "Choose listings intended for single tenants or families." }, "payment_frequency": { "title": "Payment frequency", "enum": [ "yearly", "semi_annual", "quarterly", "monthly" ], "type": "string", "description": "Choose the accepted rental payment schedule when supported." }, "bedrooms": { "title": "Bedrooms", "enum": [ "1", "2", "3", "4", "5_plus" ], "type": "string", "description": "Require one target-supported bedroom count." }, "living_rooms": { "title": "Living rooms", "enum": [ "1", "2", "3", "4", "5_plus" ], "type": "string", "description": "Require one target-supported living-room count." }, "bathrooms": { "title": "Bathrooms / WC", "enum": [ "1", "2", "3", "4_plus" ], "type": "string", "description": "Require one target-supported bathroom count." }, "floor": { "title": "Floor", "enum": [ "ground", "upper_ground", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20_plus" ], "type": "string", "description": "Choose the listing floor when supported by the property type." }, "property_age": { "title": "Property age", "enum": [ "new", "2_years", "3_years", "4_years", "5_years", "6_years", "7_years", "8_years", "9_years", "10_years", "11_years", "12_years", "13_years", "14_years", "15_years", "15_plus_years" ], "type": "string", "description": "Choose one age value from Aqar's search filter." }, "usage_type": { "title": "Property usage", "enum": [ "residential", "commercial" ], "type": "string", "description": "Choose residential or commercial usage when the selected property type supports it." }, "street_direction": { "title": "Street direction", "enum": [ "north", "east", "west", "south", "northeast", "southeast", "southwest", "northwest", "three_streets", "four_streets" ], "type": "string", "description": "Choose the property's frontage direction or street count." }, "minimum_street_width": { "title": "Minimum street width", "enum": [ "5", "10", "15", "20", "25", "30", "35", "40", "45", "50" ], "type": "string", "description": "Choose the minimum street width in meters." }, "apartments": { "title": "Apartments in building", "enum": [ "none", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30_plus" ], "type": "string", "description": "Choose the required apartment count for applicable property types." }, "stores": { "title": "Stores", "enum": [ "1", "2", "3", "4", "5_plus" ], "type": "string", "description": "Choose one target-supported store-count option." }, "furnished": { "title": "Furnished only", "type": "boolean", "description": "Turn on to require furnished listings when supported.", "default": false }, "amenities": { "title": "Amenities and features", "uniqueItems": true, "type": "array", "description": "Select one or more required Aqar features. Every selected feature is applied to the search.", "items": { "type": "string", "enum": [ "car_entrance", "air_conditioned", "special_entrance", "two_entrances", "private_roof", "in_villa", "stairs", "driver_room", "maid_room", "pool", "kitchen", "basement", "duplex", "tent", "family_section", "football_pitch", "volleyball_court", "playground" ], "enumTitles": [ "Car entrance", "Air conditioned", "Special entrance", "Two entrances", "Private roof", "In villa", "Stairs", "Driver room", "Maid room", "Pool", "Kitchen", "Basement", "Duplex", "Tent", "Family section", "Football pitch", "Volleyball court", "Playground" ] } }, "min_price": { "title": "Minimum price (SAR)", "minimum": 100, "maximum": 100000000, "type": "number", "description": "Optional minimum source price." }, "max_price": { "title": "Maximum price (SAR)", "minimum": 100, "maximum": 100000000, "type": "number", "description": "Optional maximum source price." }, "min_meter_price": { "title": "Minimum meter price (SAR)", "minimum": 100, "maximum": 100000000, "type": "number", "description": "Optional minimum price per square meter." }, "max_meter_price": { "title": "Maximum meter price (SAR)", "minimum": 100, "maximum": 100000000, "type": "number", "description": "Optional maximum price per square meter." }, "min_area": { "title": "Minimum area (m²)", "minimum": 100, "maximum": 100000000, "type": "number", "description": "Optional minimum property area." }, "max_area": { "title": "Maximum area (m²)", "minimum": 100, "maximum": 100000000, "type": "number", "description": "Optional maximum property area." }, "limit": { "title": "Maximum results", "minimum": 1, "type": "integer", "description": "Optional limit on how many results to save for the search. Leave empty to collect as many as are available." } } }, "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 } } } } } } } } } }