{ "openapi": "3.0.1", "info": { "title": "NHC Saudi Housing Projects Scraper: Prices & Availability", "description": "Scrape NHC's Saudi housing project catalogue: developer, city and ISO region code, unit count, project area, sales availability and starting prices in SAR where published. Schedule daily runs to get only new or changed projects, price and availability included. $3 per 1,000 projects.", "version": "0.1", "x-build-id": "FC4aLDC7Qnwbi33s4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automatic~nhc-saudi-projects/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automatic-nhc-saudi-projects", "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/automatic~nhc-saudi-projects/runs": { "post": { "operationId": "runs-sync-automatic-nhc-saudi-projects", "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/automatic~nhc-saudi-projects/run-sync": { "post": { "operationId": "run-sync-automatic-nhc-saudi-projects", "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": { "maxItems": { "title": "Maximum projects examined", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum unique matching NHC projects examined in one run. The run's charge limit can reduce this. With Only new or changed projects on, projects that did not change are skipped without using this limit.", "default": 25 }, "city": { "title": "City", "maxLength": 100, "type": "string", "description": "City name from the current NHC catalog, such as Riyadh, Jeddah, Dammam or Tabuk. Empty includes all cities.", "default": "" }, "keyword": { "title": "Literal catalog keyword", "maxLength": 150, "type": "string", "description": "Matches the project name, city, region or catalog description. Not developer names or brochure text.", "default": "" }, "includeDetails": { "title": "Include project details", "type": "boolean", "description": "Include developer, units, area, availability and starting price when the project page provides them.", "default": true }, "maxRunSeconds": { "title": "Maximum collection seconds", "minimum": 5, "maximum": 240, "type": "integer", "description": "Total source collection deadline. Exhausting it fails the run without submitting an incomplete dataset.", "default": 240 }, "onlyNewSinceLastRun": { "title": "Only new or changed projects", "type": "boolean", "description": "Return only projects not delivered before, or whose published details changed (price, availability, units, area, developer, description). Use it on a daily schedule to follow NHC's catalog; the first run with a filter set returns everything it examines.", "default": false }, "stateKey": { "title": "Saved state name (optional)", "maxLength": 64, "type": "string", "description": "Name of the saved list of already-delivered projects for this filter set. Leave empty to derive it from the city and keyword filters. Set the same name to continue a feed after changing maxItems.", "default": "" } } }, "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 } } } } } } } } } }