{ "openapi": "3.0.1", "info": { "title": "Aqar.fm Monitor — Saudi New Listings & Price Drops (EN/AR)", "description": "Get alerts for new Aqar.fm listings and price drops in Saudi Arabia. Schedule it daily; English + Arabic fields, price per m², district comparison.", "version": "0.1", "x-build-id": "FQIE8PO6NPHw4J5wa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s3nafps~aqar-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s3nafps-aqar-monitor", "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/s3nafps~aqar-monitor/runs": { "post": { "operationId": "runs-sync-s3nafps-aqar-monitor", "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/s3nafps~aqar-monitor/run-sync": { "post": { "operationId": "run-sync-s3nafps-aqar-monitor", "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": { "city": { "title": "City", "enum": [ "riyadh", "jeddah", "dammam", "al-khobar", "mecca", "medina", "taif", "abha", "tabuk", "buraydah" ], "type": "string", "description": "Saudi city to search. Ignored when you provide Start URLs.", "default": "riyadh" }, "category": { "title": "Category", "enum": [ "apartments-for-rent", "apartments-for-sale", "villas-for-rent", "villas-for-sale", "land-for-rent", "land-for-sale", "buildings-for-rent", "buildings-for-sale", "floors-for-rent", "floors-for-sale", "shops-for-rent", "offices-for-rent" ], "type": "string", "description": "Property type and purpose. Ignored when you provide Start URLs.", "default": "apartments-for-rent" }, "district": { "title": "District", "type": "string", "description": "Optional. Keep only listings whose district contains this text, in English or Arabic (e.g. \"Al Malqa\" or \"الملقا\"). With Start URLs, use the language of the URL." }, "minPrice": { "title": "Minimum price (SAR)", "minimum": 0, "type": "integer", "description": "Optional. For rentals this is the price per rent period shown on Aqar (usually yearly)." }, "maxPrice": { "title": "Maximum price (SAR)", "minimum": 0, "type": "integer", "description": "Optional." }, "minArea": { "title": "Minimum area (m²)", "minimum": 0, "type": "integer", "description": "Optional." }, "maxArea": { "title": "Maximum area (m²)", "minimum": 0, "type": "integer", "description": "Optional." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Optional." }, "startUrls": { "title": "Start URLs (advanced)", "type": "array", "description": "Optional. Paste Aqar.fm search URLs to watch instead of using City and Category. Results come back in the URL's language only (Arabic or English).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxListingsToTrack": { "title": "Listings to track", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many listings of this search to scan and watch each run.", "default": 500 }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Optional. Name this monitor to keep several searches apart, or change it to start fresh. Leave empty to use the search itself." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy servers used to reach Aqar.fm. Saudi residential proxies are the default because Aqar.fm blocks datacenter IPs after a few pages.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "SA" } } } }, "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 } } } } } } } } } }