{ "openapi": "3.0.1", "info": { "title": "Yad2 Real Estate Scraper", "description": "Scrape Yad2.co.il apartments for rent and sale across Israel: price, rooms, area, floor, amenities, images, description, and agent detection. Export JSON, CSV, Excel.", "version": "1.0", "x-build-id": "HFO4yIGH3guoH4tXA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~yad2-real-estate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-yad2-real-estate-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/parsebird~yad2-real-estate-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-yad2-real-estate-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/parsebird~yad2-real-estate-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-yad2-real-estate-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\"), a Yad2 city code, comma-separated for multiple cities, or \"all\" to scan every major Israeli city.", "default": "Tel Aviv" }, "dealType": { "title": "Deal type", "enum": [ "rent", "buy" ], "type": "string", "description": "Whether to scrape rental listings or listings for sale.", "default": "rent" }, "maxItems": { "title": "Max listings per city", "minimum": 1, "type": "integer", "description": "Optional cap on listings per city. Leave blank to scrape every matching listing." }, "enrichListings": { "title": "Enrich listings", "type": "boolean", "description": "Fetch each listing's detail page for the full description, contact name, publish date, roommate flag, and complete amenity list. Slower and uses one extra request per listing.", "default": false }, "minPrice": { "title": "Minimum price (ILS)", "minimum": 0, "type": "integer", "description": "Only return listings priced at or above this amount, in Israeli new shekels." }, "maxPrice": { "title": "Maximum price (ILS)", "minimum": 0, "type": "integer", "description": "Only return listings priced at or below this amount, in Israeli new shekels." }, "minRooms": { "title": "Minimum rooms", "minimum": 0, "type": "number", "description": "Only return listings with at least this many rooms (Israeli room count, e.g. 2.5, 3, 4)." }, "maxRooms": { "title": "Maximum rooms", "minimum": 0, "type": "number", "description": "Only return listings with at most this many rooms." }, "neighbourhood": { "title": "Neighbourhood or street", "type": "string", "description": "Only return listings in this neighbourhood or street (Hebrew), e.g. \"פלורנטין\" or \"דיזנגוף\"." }, "requireParking": { "title": "Has parking", "type": "boolean", "description": "Return only listings that include parking.", "default": false }, "requireElevator": { "title": "Has elevator", "type": "boolean", "description": "Return only listings in a building with an elevator.", "default": false }, "requireBalcony": { "title": "Has balcony", "type": "boolean", "description": "Return only listings that have a balcony.", "default": false }, "requireSecureRoom": { "title": "Has safe room (mamad)", "type": "boolean", "description": "Return only listings that have a safe room / reinforced room (ממ\"ד).", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy settings. Yad2 blocks non-Israeli traffic, so an Israeli residential proxy is required.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "IL" } } } }, "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 } } } } } } } } } }