{ "openapi": "3.0.1", "info": { "title": "Batdongsan $1💰 Search By URLs and Keywords", "description": "From $1/1K. Scrape Batdongsan.com.vn property listings into clean JSON. Search by listing type, property category, and city, or paste a search URL. Automatically paginates and can extract GPS, specs, agent details, dates, and high-resolution photos.", "version": "1.0", "x-build-id": "LtYd9fonvYavFFnXk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~batdongsan-com-vn-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-batdongsan-com-vn-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/abotapi~batdongsan-com-vn-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-batdongsan-com-vn-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/abotapi~batdongsan-com-vn-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-batdongsan-com-vn-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": { "mode": { "title": "1. Search mode", "enum": [ "search", "url" ], "type": "string", "description": "Search mode = pick listing type (buy/rent) + property type + city below. URL mode = paste any batdongsan.com.vn search URL already refined in a browser (recommended for price, area, or bedroom filters, since batdongsan encodes those into the URL only after you interact with the on-page filter panel).", "default": "search" }, "listingType": { "title": "Buy or rent? (Search mode)", "enum": [ "Buy", "Rent" ], "type": "string", "description": "Bán (Buy) or Cho thuê (Rent). Search mode only.", "default": "Buy" }, "propertyType": { "title": "Property type (Search mode)", "enum": [ "All", "Apartment", "PrivateHouse", "TownHouse", "Villa", "Land", "ProjectLand", "Office", "Warehouse" ], "type": "string", "description": "What kind of property to search for. Maps to a batdongsan.com.vn category. Search mode only. Note: some categories exist in only one direction on batdongsan, Office is rent-only, while Land, Project land, and Warehouse are buy-only. Picking the unavailable direction returns no results.", "default": "Apartment" }, "locations": { "title": "Cities / provinces to search (Search mode)", "type": "array", "description": "One or more Vietnamese provinces/cities. Use the batdongsan slug (tp-hcm, ha-noi, da-nang, hai-phong, can-tho) or a common name (\"Ho Chi Minh\", \"Hanoi\", \"Da Nang\"), which is slugified automatically. Leave empty for a nationwide search. Search mode only.", "items": { "type": "string" } }, "urls": { "title": "Search URLs (URL mode)", "type": "array", "description": "One or more full batdongsan.com.vn search URLs. Tip: open batdongsan.com.vn in your browser, pick listing type + property type + city + any price/area/bedroom filters, then paste the resulting URL here. Multi-URL supported. Filter-mode fields are ignored. If a URL ends with `/pN`, scraping starts at page N and walks forward.", "items": { "type": "string" } }, "maxPages": { "title": "Max pages per search", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many result pages to walk per city / URL. Batdongsan returns roughly 20 to 30 listings per page.", "default": 1 }, "maxListings": { "title": "Max total listings", "minimum": 0, "type": "integer", "description": "Hard cap across the whole run. 0 = unlimited (bounded only by Max pages).", "default": 0 }, "fetchDetails": { "title": "Visit each listing's detail page", "type": "boolean", "description": "Adds GPS latitude/longitude, full description, agent name + phone + profile link, the full specification table, posted date, expiry date, and listing code. Turn off for a faster, cheaper run with just the SERP-level fields (title, price, area, bedrooms, location, primary photo).", "default": true }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Vietnam residential proxy is strongly recommended (default). Batdongsan only serves traffic from Vietnam-reachable connections, so a VN residential exit is required for reliable results." } } }, "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 } } } } } } } } } }