{
  "openapi": "3.0.1",
  "info": {
    "title": "Yad2 Scraper - Israel Classifieds",
    "description": "Yad2 scraper for Israel's classifieds: cars and other vehicles, property for sale or rent, and second-hand goods. Filter or paste a search URL and get one row per listing: Hebrew title, price in shekels, city, seller type, specs, photos, publish date. $1.20 per 1,000 listings.",
    "version": "0.1",
    "x-build-id": "PhBhCyg1FFqgPehP6"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dami_studio~yad2-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dami_studio-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/dami_studio~yad2-scraper/runs": {
      "post": {
        "operationId": "runs-sync-dami_studio-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/dami_studio~yad2-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-dami_studio-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",
        "properties": {
          "section": {
            "title": "Section",
            "enum": [
              "vehicles",
              "realestate",
              "products"
            ],
            "type": "string",
            "description": "Which part of Yad2 to scrape. Vehicles = cars, motorcycles, scooters, trucks, watercraft. Real estate = apartments and houses for sale, for rent, and commercial property. Second-hand goods = Yad2's marketplace, which needs a search term."
          },
          "vehicleType": {
            "title": "Vehicle type",
            "enum": [
              "cars",
              "motorcycles",
              "scooters",
              "trucks",
              "watercraft"
            ],
            "type": "string",
            "description": "Only used when Section is Vehicles."
          },
          "dealType": {
            "title": "Real-estate deal type",
            "enum": [
              "forsale",
              "rent",
              "commercial"
            ],
            "type": "string",
            "description": "Only used when Section is Real estate."
          },
          "query": {
            "title": "Search term (second-hand goods only)",
            "type": "string",
            "description": "Required for the second-hand marketplace, which has no browse-everything view. Hebrew works best: ספה (sofa), אופניים (bicycle), מקרר (fridge). Latin brand names such as iPhone or PlayStation also work. Yad2's vehicle and real-estate feeds have no free-text search at all, so this field is ignored for those sections - filter with manufacturer, area, region and price instead."
          },
          "searchUrls": {
            "title": "Yad2 URLs",
            "type": "array",
            "description": "Optional. Paste Yad2 search URLs instead of filling in the fields, e.g. https://www.yad2.co.il/vehicles/cars?manufacturer=19&year=2018-2024 or https://www.yad2.co.il/realestate/forsale?city=5000. The section, manufacturer, model, area, region, city, price, year, km and hand filters in the URL are all read.",
            "items": {
              "type": "string"
            }
          },
          "manufacturers": {
            "title": "Car manufacturers",
            "type": "array",
            "description": "Optional, vehicles only. Hebrew or English names both work: \"Toyota\", \"טויוטה\", \"Mercedes-Benz\", \"Hyundai\", \"Tesla\". 69 manufacturers are recognised. Each one is crawled as its own search.",
            "items": {
              "type": "string"
            }
          },
          "areas": {
            "title": "Areas",
            "type": "array",
            "description": "Optional, vehicles only. Yad2 area by Hebrew or English name (\"Tel Aviv-Yafo area\", \"אזור חיפה והסביבה\", \"Beer Sheva area\") or numeric id. 43 areas are recognised.",
            "items": {
              "type": "string"
            }
          },
          "regions": {
            "title": "Real-estate regions",
            "type": "array",
            "description": "Optional, real estate only. Yad2 splits the country into exactly 8 regions: Center and Sharon (1), South (2), Tel Aviv and surroundings (3), Judea and Samaria (4), Northern coastal plain (5), Jerusalem (6), North and the valleys (7), Jerusalem area (8). Hebrew names and ids both work. Leave empty to sweep all eight.",
            "items": {
              "type": "string"
            }
          },
          "cityId": {
            "title": "City id (real estate)",
            "minimum": 1,
            "type": "integer",
            "description": "Optional, real estate only. Yad2's numeric city code, e.g. 5000 = Tel Aviv-Yafo, 3000 = Jerusalem, 4000 = Haifa. Take it from the city= parameter of a Yad2 URL. A city only matches inside its own region, so leave Regions empty and the actor will find the right one."
          },
          "minRooms": {
            "title": "Minimum rooms (real estate)",
            "minimum": 1,
            "maximum": 12,
            "type": "number",
            "description": "Optional, real estate only. The fewest rooms a listing may have, counted the way Yad2 counts them, so 3.5 works. Yad2 applies it, so you only get and pay for listings that match. Set on a vehicle or second-hand search, that search is not run."
          },
          "minPrice": {
            "title": "Minimum price (₪)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional. Prices are in Israeli new shekels."
          },
          "maxPrice": {
            "title": "Maximum price (₪)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional. Prices are in Israeli new shekels."
          },
          "minYear": {
            "title": "Earliest model year",
            "minimum": 1900,
            "type": "integer",
            "description": "Earliest model year to keep. Vehicle categories only, it is ignored on property and other listings."
          },
          "maxYear": {
            "title": "Latest model year",
            "minimum": 1900,
            "type": "integer",
            "description": "Latest model year to keep. Vehicle categories only, it is ignored on property and other listings."
          },
          "maxKm": {
            "title": "Maximum kilometres",
            "minimum": 0,
            "type": "integer",
            "description": "Optional, vehicles only. Upper bound on the odometer reading."
          },
          "sellerType": {
            "title": "Seller type",
            "enum": [
              "any",
              "private",
              "business"
            ],
            "type": "string",
            "description": "Yad2 has no seller filter, so this is applied by the actor after the results come back. Listings that do not match are dropped and are never charged."
          },
          "includeDetails": {
            "title": "Fetch publish date, full title and description",
            "type": "boolean",
            "description": "On by default for vehicles and real estate. Yad2's list feeds carry no publish date, no description and no written title, so the actor makes one extra request per listing to get them. Turn this off to run roughly twice as fast when you only need price, location and photos. Second-hand goods already include their title in the list feed and are unaffected."
          },
          "businessOnly": {
            "title": "Shops only (second-hand goods)",
            "type": "boolean",
            "description": "Optional, second-hand goods only. Return only listings from Yad2 business sellers."
          },
          "maxItems": {
            "title": "Maximum listings",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "How many listings to return in total. Each returned listing is one charged result; dropped, duplicate and failed rows are never charged. A single vehicle search reaches about 59,000 listings; a real-estate region reaches a few thousand through automatic price-band splitting."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional. Leave it empty for a normal run. Add your own proxy servers here only if you want requests to go through them."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}