{ "openapi": "3.0.1", "info": { "title": "Yad2.co.il Real Estate Scraper", "description": "Scrape real estate listings (rent & buy) from Yad2.co.il, Israel's #1 classifieds site. High-coverage scraping with price, rooms, area, amenities, images, and descriptions across 127+ Israeli cities.", "version": "1.0", "x-build-id": "eD3Tucv4I8j0hvrHc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/swerve~yad2-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-swerve-yad2-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/swerve~yad2-scraper/runs": { "post": { "operationId": "runs-sync-swerve-yad2-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/swerve~yad2-scraper/run-sync": { "post": { "operationId": "run-sync-swerve-yad2-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": [ "city", "dealType" ], "properties": { "city": { "title": "City", "type": "string", "description": "City name in Hebrew or English (e.g. 'Tel Aviv', 'תל אביב', 'Haifa', 'Jerusalem'). Comma-separated for multiple cities, or 'all' for all 127+ cities. Common cities: Tel Aviv, Jerusalem, Haifa, Beer Sheva, Raanana, Herzliya, Netanya, Ashdod, Rishon Lezion, Petah Tikva, Ramat Gan, Holon, Bat Yam, Rehovot, Modiin, Ashkelon, Kfar Saba, Hadera, Bnei Brak, Eilat" }, "dealType": { "title": "Deal Type", "enum": [ "rent", "buy" ], "type": "string", "description": "Type of listing to scrape", "default": "rent" }, "maxItems": { "title": "Max Listings Per City", "minimum": 1, "maximum": 700, "type": "integer", "description": "Maximum listings per city. Big cities can yield 400+ results.", "default": 200 }, "minPrice": { "title": "Min Price (₪)", "type": "integer", "description": "Minimum price filter in ILS (optional)" }, "maxPrice": { "title": "Max Price (₪)", "type": "integer", "description": "Maximum price filter in ILS (optional)" }, "minRooms": { "title": "Min Rooms", "type": "number", "description": "Minimum number of rooms (optional)" }, "maxRooms": { "title": "Max Rooms", "type": "number", "description": "Maximum number of rooms (optional)" }, "neighbourhood": { "title": "Neighbourhood / Street (שכונה / רחוב)", "type": "string", "description": "Filter by neighbourhood or street name in Hebrew (e.g. נווה צדק, הצפון הישן). Matches against neighbourhood, street name, and address fields." }, "requireParking": { "title": "Require Parking", "type": "boolean", "description": "Only return listings that have parking", "default": false }, "requireElevator": { "title": "Require Elevator", "type": "boolean", "description": "Only return listings with an elevator in the building", "default": false }, "requireBalcony": { "title": "Require Balcony", "type": "boolean", "description": "Only return listings that have a balcony", "default": false }, "requireSecureRoom": { "title": "Require Secure Room (ממ״ד)", "type": "boolean", "description": "Only return listings that have a secure room (safe room / mamad)", "default": false }, "enrichListings": { "title": "Enrich Listing Details", "type": "boolean", "description": "Fetches additional details for each listing: phone number, contact name, full description, amenities (elevator, parking, balcony, safe room), and definitive agent detection. Without this, these fields will be null. Adds ~1 second per 5 listings. Note: for large result sets (100+ listings), enrichment may be partially blocked by Yad2 — the scraper will output all listings but some may have null enrichment fields.", "default": false }, "proxyConfig": { "title": "Proxy Configuration", "type": "object", "description": "Optional. Leave as 'No proxy' — the scraper handles geo-routing automatically. Only change if instructed by support." } } }, "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 } } } } } } } } } }