{ "openapi": "3.0.1", "info": { "title": "Batdongsan.com.vn Scraper – Vietnam Real Estate", "description": "Scrape batdongsan.com.vn property listings for sale and rent in all 54 Vietnamese provinces. Extract price in VND, area, bedrooms, district, agent, images, legal status, expiry date and GPS. Pay per listing, JSON/CSV export, API and MCP access.", "version": "0.1", "x-build-id": "r6qF7TXTZtIJ6LEFH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/anxuanng~batdongsan-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-anxuanng-batdongsan-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/anxuanng~batdongsan-scraper/runs": { "post": { "operationId": "runs-sync-anxuanng-batdongsan-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/anxuanng~batdongsan-scraper/run-sync": { "post": { "operationId": "run-sync-anxuanng-batdongsan-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": { "listingType": { "title": "Listing type", "enum": [ "sell", "rent" ], "type": "string", "description": "Sale (nhà đất bán) or rent (nhà đất cho thuê). Ignored when startUrls is set.", "default": "sell" }, "city": { "title": "City / province", "enum": [ "", "tp-hcm", "ha-noi", "binh-duong", "da-nang", "hai-phong", "dong-nai", "hung-yen", "ba-ria-vung-tau", "khanh-hoa", "long-an", "can-tho", "bac-ninh", "quang-ninh", "vinh-phuc", "lam-dong", "ha-nam", "kien-giang", "hai-duong", "thai-nguyen", "binh-dinh", "binh-phuoc", "tien-giang", "bac-giang", "quang-nam", "vinh-long", "thanh-hoa", "nam-dinh", "nghe-an", "binh-thuan", "tay-ninh", "ninh-binh", "hoa-binh", "thai-binh", "phu-tho", "thua-thien-hue", "dak-lak", "ninh-thuan", "phu-yen", "tra-vinh", "an-giang", "hau-giang", "ben-tre", "quang-ngai", "lang-son", "tuyen-quang", "soc-trang", "quang-tri", "quang-binh", "ha-tinh", "dong-thap", "bac-lieu", "yen-bai", "lao-cai", "ca-mau" ], "type": "string", "description": "Province as used in batdongsan.com.vn URLs. Leave empty for nationwide.", "default": "ha-noi" }, "propertyType": { "title": "Property type slug", "type": "string", "description": "Optional: can-ho-chung-cu, nha-rieng, nha-mat-pho, nha-biet-thu-lien-ke, dat, dat-nen-du-an, kho-nha-xuong, van-phong… Empty = all types." }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Any batdongsan.com.vn listing URL (with filters/pagination) or detail URL (…-pr12345678). Overrides the filters above.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max listings", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many listings. Charged per listing actually pushed.", "default": 100 }, "maxPages": { "title": "Max pages per start URL", "minimum": 1, "maximum": 3000, "type": "integer", "description": "Safety cap on pagination depth (30 listings per page).", "default": 50 }, "fetchDetails": { "title": "Fetch detail pages", "type": "boolean", "description": "Open each listing for full address, floors, direction, legal status, furnishing, expiry, GPS. Charged as a separate 'detail' event.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential proxy with country VN recommended. The site runs a Cloudflare challenge that blocks most datacenter IPs." } } }, "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 } } } } } } } } } }