{ "openapi": "3.0.1", "info": { "title": "Yad2 Real Estate Scraper - Israel Property Listings", "description": "Scrape Yad2.co.il real estate: homes for sale, rentals and commercial property across Israel, with price, rooms, size, floor, address, GPS, photos, amenities, seller phone and recorded sales nearby.", "version": "0.0", "x-build-id": "daBdJFR1aQb5wlY9o" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nice_dev~yad2-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nice_dev-yad2-listings-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/nice_dev~yad2-listings-scraper/runs": { "post": { "operationId": "runs-sync-nice_dev-yad2-listings-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/nice_dev~yad2-listings-scraper/run-sync": { "post": { "operationId": "run-sync-nice_dev-yad2-listings-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": { "startUrls": { "title": "Start URLs", "maxItems": 1000, "type": "array", "description": "Yad2 real estate search URLs (`https://www.yad2.co.il/realestate/forsale?topArea=2&area=1&city=5000`, and the same for rent and commercial pages — the filters set on the site are kept except pets allowed / for roommates, which Yad2 refuses to scrapers — use the petsAllowed / forRoommates columns; pagination is automatic) or single listing URLs (`https://www.yad2.co.il/realestate/item/5mv5v9te`). When this list is not empty, the search fields below (deal type, locations, keywords, search filters) are ignored; caps, post-filters, options and monitoring still apply. Max 1 000 URLs.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "dealType": { "title": "Deal type", "enum": [ "forsale", "rent", "commercial" ], "type": "string", "description": "Which Yad2 board to search: homes for sale, homes for rent, or commercial property (offices, shops, warehouses…).", "default": "forsale" }, "commercialDealType": { "title": "Commercial: sale or rent", "enum": [ "any", "forsale", "rent" ], "type": "string", "description": "Only for **Deal type** = Commercial: both, sale only or rent only.", "default": "any" }, "location": { "title": "Location", "maxLength": 200, "type": "string", "description": "A city in English (`Tel Aviv`, `Haifa`, `Petah Tikva`: the usual spellings work), or a city, neighbourhood, street or area in Hebrew (`תל אביב יפו`, `פלורנטין`), or a Yad2 id such as `city:5000`. The first match is used and written in the log. Empty = the whole **Region** (or all of Israel)." }, "locations": { "title": "More locations", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Several places in one run: one search per place (times each keyword below, max 500). Added to **Location**; listings found by several searches are saved once.", "default": [], "items": { "type": "string" } }, "region": { "title": "Region", "enum": [ "all", "1", "2", "3", "4", "5", "6", "7", "8" ], "type": "string", "description": "Search a whole Yad2 region when **Location** is empty; the first choice walks the 8 regions one after another. Ignored when a location is given (its region is found automatically).", "default": "all" }, "query": { "title": "Search keyword", "maxLength": 200, "type": "string", "description": "Free-text search of the site (Hebrew works best, e.g. `ים` for sea view). Empty = no keyword." }, "searchQueries": { "title": "More search keywords", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Several keywords in one run: one search per keyword (times each location). Added to **Search keyword**.", "default": [], "items": { "type": "string" } }, "propertyTypes": { "title": "Property types", "uniqueItems": true, "type": "array", "description": "Only these property types (any of them). Empty = all types. Homes and commercial types are listed together: pick the ones of your **Deal type**.", "items": { "type": "string", "enum": [ "1", "3", "4", "5", "6", "7", "51", "39", "11", "49", "43", "25", "44", "33", "32", "30", "45", "50", "41", "12", "13", "14", "59", "62", "16", "19", "20", "35", "38", "60", "58", "18", "24" ], "enumTitles": [ "Apartment", "Garden apartment", "Studio / loft", "House / cottage", "Penthouse / rooftop", "Duplex", "Triplex", "Semi-detached house", "Apartment unit", "Basement / parterre", "Sublet (rentals)", "Vacation apartment", "Residential building", "Plot", "Farm / agricultural plot", "Parking space", "Storage unit", "Purchase group", "Other (homes)", "Offices (commercial)", "Shop / retail space (commercial)", "Clinic (commercial)", "Studio (commercial)", "Coworking space (commercial)", "Warehouse (commercial)", "Industrial building (commercial)", "Event hall (commercial)", "Office building (commercial)", "Parking lot (commercial)", "Hotel (commercial)", "Basement (commercial)", "Plot (commercial)", "Other (commercial)" ] }, "default": [] }, "minPrice": { "title": "Min price (₪)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Minimum price in Israeli shekels (monthly rent for rentals)." }, "maxPrice": { "title": "Max price (₪)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Maximum price in Israeli shekels (monthly rent for rentals)." }, "minRooms": { "title": "Min rooms", "minimum": 0, "maximum": 20, "type": "number", "description": "Minimum number of rooms (half rooms allowed, e.g. `2.5`)." }, "maxRooms": { "title": "Max rooms", "minimum": 0, "maximum": 20, "type": "number", "description": "Maximum number of rooms." }, "minSquareMeters": { "title": "Min size (m²)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Minimum floor area in square meters." }, "maxSquareMeters": { "title": "Max size (m²)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Maximum floor area in square meters." }, "minFloor": { "title": "Min floor", "minimum": -5, "maximum": 100, "type": "integer", "description": "Lowest floor (ground floor = 0)." }, "maxFloor": { "title": "Max floor", "minimum": -5, "maximum": 100, "type": "integer", "description": "Highest floor (ground floor = 0)." }, "propertyConditions": { "title": "Property condition", "uniqueItems": true, "type": "array", "description": "Only listings in one of these conditions. Empty = any condition.", "items": { "type": "string", "enum": [ "1", "6", "2", "3", "5" ], "enumTitles": [ "New from the developer", "New (lived in)", "Renovated", "Well kept", "Needs renovation" ] }, "default": [] }, "sellerType": { "title": "Seller type", "enum": [ "any", "private", "agency" ], "type": "string", "description": "Private owners only, agencies (brokers) only, or both.", "default": "any" }, "requireParking": { "title": "With parking", "type": "boolean", "description": "Only listings with parking.", "default": false }, "requireElevator": { "title": "With elevator", "type": "boolean", "description": "Only listings with an elevator.", "default": false }, "requireBalcony": { "title": "With balcony", "type": "boolean", "description": "Only listings with a balcony.", "default": false }, "requireSecureRoom": { "title": "With safe room (mamad)", "type": "boolean", "description": "Only listings with a secure room (ממ״ד).", "default": false }, "requireAirConditioning": { "title": "With air conditioning", "type": "boolean", "description": "Only listings with air conditioning.", "default": false }, "requireStorage": { "title": "With storage room", "type": "boolean", "description": "Only listings with a storage room.", "default": false }, "requireAccessibility": { "title": "Wheelchair accessible", "type": "boolean", "description": "Only listings accessible to people with disabilities.", "default": false }, "requireWindowBars": { "title": "With window bars", "type": "boolean", "description": "Only listings with window bars (סורגים).", "default": false }, "requireRenovated": { "title": "Renovated", "type": "boolean", "description": "Only listings marked as renovated.", "default": false }, "requireFurnished": { "title": "Furnished", "type": "boolean", "description": "Only furnished listings.", "default": false }, "exclusiveOnly": { "title": "Exclusive listings only", "type": "boolean", "description": "Only listings marketed exclusively by one agency.", "default": false }, "priceDroppedOnly": { "title": "Price dropped only", "type": "boolean", "description": "Only listings whose price was reduced (the previous price is in `priceBefore`).", "default": false }, "withPhotosOnly": { "title": "With photos only", "type": "boolean", "description": "Skip listings without any photo.", "default": false }, "withPriceOnly": { "title": "With price only", "type": "boolean", "description": "Skip listings whose price is not shown.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "newest", "priceAsc", "priceDesc" ], "type": "string", "description": "Order in which Yad2 returns the listings (applied by the site before collection, so a capped run gets the right end of each group). Newest first = most recently published or bumped first. Yad2 sorts private listings and agency listings separately and gives the private ones first on each page: with all sellers, a cap of 20 or less may hold private listings only.", "default": "newest" }, "maxItems": { "title": "Max listings", "minimum": 0, "maximum": 200000, "type": "integer", "description": "Maximum number of listings to save for the whole run (after deduplication and filters). 0 = no limit.", "default": 100 }, "maxItemsPerQuery": { "title": "Max listings per search", "minimum": 0, "maximum": 200000, "type": "integer", "description": "Cap for EACH search (location × keyword, or search URL), so that the first search cannot use up the whole **Max listings** budget. 0 = no per-search cap.", "default": 0 }, "extractDetails": { "title": "Listing details", "type": "boolean", "description": "Open each listing (1 extra request) for the description, publication / update dates, all amenities, entrance date, building floors, parking spaces, agency and licence numbers, English place names. Needed by **Posted after / before**. Off by default: tick it to get these fields.", "default": false }, "includeContacts": { "title": "Seller phone numbers", "type": "boolean", "description": "Seller name and phone number(s), and each broker's phone and licence number (1 extra request per listing; with Listing details off, the listing page is read too, and not charged). Yad2 hands out a limited number of phone numbers per IP address, so runs with this option are slower.", "default": false }, "includeNearbyDeals": { "title": "Recorded sales nearby", "type": "boolean", "description": "Closest recorded sales (sale price, date, rooms, size, floor, building year, address) around each listing, from Yad2's sold-property data. Turns on **Listing details**.", "default": false }, "nearbyDealsLimit": { "title": "Recorded sales per listing", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many nearby recorded sales to attach to each listing (closest first).", "default": 10 }, "includePriceTrend": { "title": "Local price trend", "type": "boolean", "description": "Monthly average asking price per m² for comparable homes around each listing since 2023 (for-sale homes only). Turns on **Listing details**.", "default": false }, "postedAfter": { "title": "Posted after", "type": "string", "description": "Only listings first published on or after this date: `2026-09-01`, or a period before now such as `7 days`, `2 weeks`, `1 month` (API: `24 hours` and full ISO date-times work too). Needs **Listing details**." }, "postedBefore": { "title": "Posted before", "type": "string", "description": "Only listings first published on or before this date (the whole day is included), or older than a period such as `30 days`. Needs **Listing details**." }, "excludeKeywords": { "title": "Exclude keywords", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Drop the listings whose title or features contain one of these words (case ignored); the description too when Listing details is ticked.", "default": [], "items": { "type": "string" } }, "onlyNew": { "title": "Only new listings", "type": "boolean", "description": "Skip the listings that a previous run (same **Memory key**) already delivered: they are not saved and not charged, and their page is not even opened. First run = everything is new.", "default": false }, "includePriceChanges": { "title": "Also listings whose price changed", "type": "boolean", "description": "With **Only new listings**: also return the listings already delivered whose price went up or down since the last row delivered (`changeType` = `price_drop` / `price_rise`, with `previousPrice` and `priceChangePercent`). Charged per price change delivered (event `price-change`). A listing without a price is never a change.", "default": false }, "minPriceChangePercent": { "title": "Min price change (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "With **Also listings whose price changed**: a listing comes back only if its price moved by at least this many percent.", "default": 3 }, "stateKey": { "title": "Memory key", "pattern": "^[a-zA-Z0-9_-]{1,64}$", "maxLength": 64, "type": "string", "description": "Name of the memory used by **Only new listings**. Give each schedule / task its own key (e.g. `tlv-rentals`) so that they do not share their memory. Letters, digits, `-` and `_`.", "default": "default" }, "resetState": { "title": "Reset the memory", "type": "boolean", "description": "Forget everything remembered under this **Memory key** before the run: this run returns (and charges) every listing again. Untick it afterwards.", "default": false }, "knownListingsDatasetId": { "title": "Dataset of listings you already have", "maxLength": 100, "type": "string", "description": "With **Only new listings**: a dataset of your account (a past run of this Actor, or any other tool) whose listings are put in the memory as already delivered, before the site is read: they are never returned and never charged. The token is read in `id`, or in a Yad2 link (`url`, `link`, `adUrl`, `listingUrl`). With **Also listings whose price changed**, a `price` above 0 becomes the price known. The Actor can read this dataset only." }, "knownListingIds": { "title": "Listings you already have (IDs or links)", "maxItems": 100000, "type": "array", "description": "With **Only new listings**: Yad2 listing tokens (`5mv5v9te`) or links (`https://www.yad2.co.il/realestate/item/5mv5v9te`) put in the memory as already delivered: never returned, never charged. Up to 100 000; for more, use the dataset field.", "default": [], "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy or your own proxies. Keep the default: it is included in the price. The residential Apify proxy is not available in this Actor.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of requests processed in parallel.", "default": 8 }, "maxRequestsPerMinute": { "title": "Max requests per minute", "minimum": 10, "maximum": 2000, "type": "integer", "description": "Most requests to Yad2 in any 60 seconds, all of them counted: results pages, listing pages and the extra pages read for a listing (phone numbers, recorded sales, price trend). A budget, not an even pace: up to this many can leave at once when the minute starts (spread them with the minimum delay below). Lower it if the site answers HTTP 429 / 403 in the log.", "default": 300 }, "minRequestIntervalMs": { "title": "Min delay between requests", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Smallest gap between two requests, in milliseconds. Unlike the per-minute rate, this spreads the requests evenly instead of letting them go out in a burst. 0 = no gap.", "default": 0 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "maximum": 20, "type": "integer", "description": "Retries per request before it is marked as failed. Behind a proxy, a request the site turns away is also retried on a new proxy session up to 10 times without using up these retries.", "default": 5 }, "stopOnBlocked": { "title": "Stop at the first refusal", "type": "boolean", "description": "Stop the run as soon as Yad2 refuses one request (HTTP 403, 429 or a verification page). That request is not tried again, no other proxy address is tried and no more requests are sent. The listings already saved are kept and charged as usual. A refused phone number counts as a refusal too. Off = a refused request is tried again on another address.", "default": false }, "debugLog": { "title": "Debug log", "type": "boolean", "description": "Include debug messages in the run log.", "default": false } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }