{ "openapi": "3.0.1", "info": { "title": "Yad2 All-in-One Scraper - Real Estate, Cars & Products", "description": "Scrape Yad2 apartments for rent and sale, cars and second-hand products. Search by category and filters, paginate results, and export prices, locations, images and optional listing details in one consistent dataset.", "version": "0.0", "x-build-id": "aFabB8LRwCKNE0Pbz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/leadproof~yad2-all/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-leadproof-yad2-all", "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/leadproof~yad2-all/runs": { "post": { "operationId": "runs-sync-leadproof-yad2-all", "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/leadproof~yad2-all/run-sync": { "post": { "operationId": "run-sync-leadproof-yad2-all", "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": { "category": { "title": "Category", "enum": [ "real_estate", "vehicles", "products" ], "type": "string", "description": "Choose a category. One category per run.", "default": "real_estate" }, "transactionType": { "title": "Transaction", "enum": [ "rent", "sale", "commercial" ], "type": "string", "description": "For real_estate only. Rent is the default. Commercial covers offices, shops and other business property." }, "vehicleType": { "title": "Vehicle type", "enum": [ "cars", "motorcycles", "scooters", "trucks", "watercraft" ], "type": "string", "description": "For vehicles only. Cars is the default." }, "sources": { "title": "Sources", "uniqueItems": true, "type": "array", "description": "Sites to search. Madlan covers real estate (rent, sale, commercial) and adds price history and neighborhood scores. Results from all sources share one output format; each row names its source.", "items": { "type": "string", "enum": [ "yad2", "madlan" ], "enumTitles": [ "Yad2", "Madlan" ] }, "default": [ "yad2" ] }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum delivered listings across all searches. Large runs (thousands of listings) finish in about a minute.", "default": 100 }, "filters": { "title": "Filters", "type": "object", "description": "Filters require matching source evidence. City and product category select source feeds automatically. Remaining filters are enforced locally.", "properties": { "city": { "title": "City", "type": "string", "description": "Real estate: city or locality name as Yad2 shows it, or several separated by commas (for example צפרירים, אביעזר). Resolved with the Yad2 place search, so small moshavim and kibbutzim work; common English names (Tel Aviv, Jerusalem, Haifa) are accepted. Vehicles: requires Read listing details, because search cards show only the area. Madlan uses the same names.", "editor": "textfield" }, "area": { "title": "Area", "type": "string", "description": "Yad2 area name, for example \"אזור בית שמש והסביבה\", or several separated by commas. Real estate resolves it with the Yad2 place search; vehicles match the area shown on each card.", "editor": "textfield" }, "minPrice": { "title": "Minimum price (ILS)", "type": "integer", "description": "Inclusive minimum price in ILS. Applied by the source and checked again on every row.", "minimum": 0 }, "maxPrice": { "title": "Maximum price (ILS)", "type": "integer", "description": "Inclusive maximum price in ILS. Applied by the source and checked again on every row.", "minimum": 0 }, "rooms": { "title": "Exact rooms", "type": "number", "description": "Real estate only. Exact room count, including half rooms.", "minimum": 0 }, "minRooms": { "title": "Minimum rooms", "type": "number", "description": "Real estate only. Inclusive minimum.", "minimum": 0 }, "maxRooms": { "title": "Maximum rooms", "type": "number", "description": "Real estate only. Inclusive maximum.", "minimum": 0 }, "propertyType": { "title": "Property type", "type": "string", "description": "Real estate only. Source property type; apartment and house aliases are supported.", "editor": "textfield" }, "minSize": { "title": "Minimum size (sqm)", "type": "integer", "description": "Real estate only. Inclusive minimum.", "minimum": 0 }, "maxSize": { "title": "Maximum size (sqm)", "type": "integer", "description": "Real estate only. Inclusive maximum.", "minimum": 0 }, "floor": { "title": "Floor", "type": "integer", "description": "Real estate only. Exact floor; basement values can be negative." }, "parking": { "title": "Parking", "type": "boolean", "description": "Real estate only. Requires Read listing details. True requires explicit parking evidence; false requires explicit absence." }, "elevator": { "title": "Elevator", "type": "boolean", "description": "Real estate only. Requires Read listing details. Omit for no preference." }, "furnished": { "title": "Furnished", "type": "boolean", "description": "Real estate only. Requires Read listing details. Omit for no preference." }, "priceDropped": { "title": "Price dropped", "type": "boolean", "description": "Real estate only. True keeps listings whose price was lowered (Yad2 shows the old price; Madlan keeps the price history)." }, "manufacturer": { "title": "Manufacturer", "type": "string", "description": "Vehicles only. Hebrew source name or an English name such as Toyota, BMW or Yamaha; several separated by commas.", "editor": "textfield" }, "model": { "title": "Model", "type": "string", "description": "Vehicles only. Source model name, for example קורולה (Corolla is an alias). Needs Manufacturer.", "editor": "textfield" }, "yearFrom": { "title": "Year from", "type": "integer", "description": "Vehicles only. Inclusive minimum year.", "minimum": 0 }, "yearTo": { "title": "Year to", "type": "integer", "description": "Vehicles only. Inclusive maximum year.", "minimum": 0 }, "maxMileage": { "title": "Maximum mileage (km)", "type": "integer", "description": "Vehicles only. Inclusive maximum. Applied by Yad2; with Read listing details the exact mileage is also returned.", "minimum": 0 }, "maxHand": { "title": "Maximum hand (owners)", "type": "integer", "description": "Vehicles only. Inclusive maximum number of previous hands, for example 2. Applied by Yad2 and checked on every row.", "minimum": 0 }, "fuelType": { "title": "Fuel type", "type": "string", "description": "Vehicles only. Source value or hybrid, electric, petrol, diesel.", "editor": "textfield" }, "gearbox": { "title": "Gearbox", "type": "string", "description": "Vehicles only. automatic or manual (or the Hebrew source value). Applied by Yad2 for cars; other vehicle types need Read listing details.", "editor": "textfield" }, "category": { "title": "Product category", "type": "string", "description": "Market only. Yad2 Market category or subcategory title, for example ריהוט, אלקטרוניקה or מכשירים סלולריים; English names such as furniture and electronics work too.", "editor": "textfield" }, "subcategory": { "title": "Product subcategory", "type": "string", "description": "Market only. A subcategory title under Product category, for example חדר שינה; otherwise matched locally on the product type.", "editor": "textfield" }, "query": { "title": "Product search text", "type": "string", "description": "Market only. All words must appear in the title or description (checked on every item).", "editor": "textfield" }, "condition": { "title": "Condition", "type": "string", "description": "Market only. Source condition (חדש באריזה, כמו חדש, משומש) or new, like new, used.", "editor": "textfield" } }, "additionalProperties": false }, "searchUrls": { "title": "Yad2 search URLs", "maxItems": 20, "type": "array", "description": "Optional. Public Yad2 search URLs copied from the browser, for example https://www.yad2.co.il/realestate/rent/tel-aviv-area?city=5000&minRooms=3, a cars/motorcycles URL, or a market.yad2.co.il collection. They replace the generated searches.", "items": { "type": "string" } }, "includeDetails": { "title": "Read listing details", "type": "boolean", "description": "Reads each listing page for description, dates, amenities, broker licence, car mileage, gearbox, colour and full spec. One extra small request per delivered listing. Required for filters on those fields.", "default": false }, "onlyNewListings": { "title": "Only new or changed listings", "type": "boolean", "description": "Remembers every delivered listing and its price in a named key-value store. Later runs with the same search deliver only new listings and price changes, marked in changeType. Ideal for scheduled monitoring.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Optional name for the memory of Only new or changed listings, for example haifa-rentals. Without it the memory is keyed to the search itself. Setting it turns the mode on." }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Total search-page limit across all searches. Leave empty to size it to Maximum results." }, "maxRequests": { "title": "Maximum requests", "minimum": 1, "maximum": 500000, "type": "integer", "description": "Hard request budget including details and retries. Leave empty to size it to Maximum results." }, "maxRunSeconds": { "title": "Maximum run time (seconds)", "minimum": 1, "maximum": 86400, "type": "integer", "description": "Crawler time limit across checkpoint resumes. Leave empty for at least 240 seconds, more for very large runs." }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 50, "type": "integer", "description": "Requests in flight at once, each from its own IP. 20 is fast and gentle on the source.", "default": 20 }, "requestDelaySeconds": { "title": "Request delay (seconds)", "minimum": 1, "maximum": 60, "type": "number", "description": "Browser transport only: minimum interval between page loads.", "default": 2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Israeli residential proxy by default. Every request uses a new session (IP); requests flagged by the source are retried from other IPs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "IL" } }, "transport": { "title": "Transport", "enum": [ "gateway", "browser", "http" ], "type": "string", "description": "Gateway (default) reads the Yad2 mobile JSON gateway and the Yad2 Market storefront: fast, low memory, low proxy use. Chrome is kept as a fallback for sale and rent real estate, cars and market pages.", "default": "gateway" }, "debugSource": { "title": "Source diagnostics", "type": "boolean", "description": "Development only: save bounded public feed structure and search links for parser diagnosis.", "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 } } } } } } } } } }