{ "openapi": "3.0.1", "info": { "title": "Fang.com (房天下) Real Estate Scraper", "description": "Scrape fang.com - one of China's largest real estate portals. Browse second-hand (sale) listings, rental listings, and new-home projects by city; search listings by keyword; or fetch a single listing/project by URL. Returns title, price, price per sqm, location, rooms, area, images, and publish d...", "version": "1.0", "x-build-id": "Qg6U0CnReDaTBgnRx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~fang-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-fang-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/crawlerbros~fang-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-fang-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/crawlerbros~fang-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-fang-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "byCity", "search", "byListingUrl" ], "type": "string", "description": "What to fetch.", "default": "byCity" }, "listingType": { "title": "Listing type", "enum": [ "sale", "rent", "newHome" ], "type": "string", "description": "Kind of listings to browse (mode=byCity).", "default": "sale" }, "city": { "title": "City", "enum": [ "national", "bj", "sh", "gz", "sz", "cd", "hz", "tj", "wh", "cq", "nj", "su", "xian", "jn", "qd", "shenyang", "dalian", "changchun", "harbin", "shijiazhuang", "taiyuan", "zhengzhou", "hf", "nanchang", "changsha", "fuzhou", "xm", "nanning", "haikou", "kunming", "guiyang", "lanzhou", "xining", "yinchuan", "lasa", "hk" ], "type": "string", "description": "City code used for the listing browse / search (mode=byCity, mode=search). `national` lists across all cities for sale and new-home; rent has no national listing and falls back to Beijing `bj`. Codes are auto-mapped to each site's canonical code (e.g. `shenyang`→`sy`, `wh`→`wuhan`); hohhot and urumqi are not covered by fang.com and are not offered.", "default": "national" }, "searchQuery": { "title": "Search keyword", "type": "string", "description": "Keyword to search listings by (mode=search). Matches community names, titles and addresses. e.g. `四龙观`, `亦庄`, `东洲家园`.", "default": "亦庄" }, "listingUrls": { "title": "Listing URLs (mode=byListingUrl)", "type": "array", "description": "esf.fang.com sale URLs (`https://esf.fang.com/chushou/16_5350069.htm`), zu.fang.com rent URLs (`https://zu.fang.com/bj/chuzu/3_511000130_1.htm`) or newhouse.fang.com project URLs (`https://newhouse.fang.com/loupan/1010187383.htm`).", "default": [], "items": { "type": "string" } }, "rooms": { "title": "Rooms filter", "enum": [ "any", "one", "two", "three", "four", "five", "fivePlus" ], "type": "string", "description": "Bedroom count filter. Applied server-side for sale listings; client-side for rent and new-home (mode=byCity).", "default": "any" }, "sortOrder": { "title": "Sort order (mode=byCity)", "enum": [ "default", "latest", "priceAsc", "areaAsc" ], "type": "string", "description": "List sort applied server-side for sale and rent lists.", "default": "default" }, "minPriceWan": { "title": "Min price (10k CNY, 万)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Drop listings cheaper than this. Sale prices are in 万; rent prices are in CNY/month (same field, applied as absolute)." }, "maxPriceWan": { "title": "Max price (10k CNY, 万)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Drop listings more expensive than this." }, "minAreaSqm": { "title": "Min area (sqm)", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Drop listings smaller than this." }, "maxAreaSqm": { "title": "Max area (sqm)", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Drop listings larger than this." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on emitted records.", "default": 20 } } }, "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 } } } } } } } } } }