{
  "openapi": "3.0.1",
  "info": {
    "title": "Kleinanzeigen Scraper & Kleinanzeigen API: Deals & Alerts",
    "description": "Kleinanzeigen API & scraper for German classifieds (ex eBay Kleinanzeigen): Kleinanzeigen Autos, Kleinanzeigen Immobilien, Kleinanzeigen Wohnung mieten and all ads, Kleinanzeigen prices with a 0–100 deal score, monitor mode for new ads & price drops (Suchauftrag, Preisalarm), Kleinanzeigen alerts.",
    "version": "1.1",
    "x-build-id": "S4Fv0VcKtJ0GVFDs2"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/euroscrape~kleinanzeigen-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-euroscrape-kleinanzeigen-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/euroscrape~kleinanzeigen-scraper/runs": {
      "post": {
        "operationId": "runs-sync-euroscrape-kleinanzeigen-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/euroscrape~kleinanzeigen-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-euroscrape-kleinanzeigen-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": {
          "keywords": {
            "title": "🔎 Keywords",
            "type": "array",
            "description": "One or more search terms, e.g. \"e-bike\", \"iPhone 15 Pro\". Each keyword is searched in every location.",
            "items": {
              "type": "string"
            }
          },
          "locations": {
            "title": "📍 Locations",
            "type": "array",
            "description": "Cities or postal codes, e.g. \"Berlin\", \"80331\". Leave empty for all of Germany.",
            "items": {
              "type": "string"
            }
          },
          "radiusKm": {
            "title": "Radius (km)",
            "minimum": 0,
            "maximum": 200,
            "type": "integer",
            "description": "Search radius around each location (Kleinanzeigen supports 5, 10, 20, 30, 50, 100, 150 or 200 km; other values are rounded).",
            "default": 0
          },
          "minPrice": {
            "title": "Min price (€)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional."
          },
          "maxPrice": {
            "title": "Max price (€)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional."
          },
          "minAreaSqm": {
            "title": "Real estate: min living area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional. Keeps flats and houses with at least this area (read from each ad card)."
          },
          "minRooms": {
            "title": "Real estate: min rooms",
            "minimum": 0,
            "type": "integer",
            "description": "Optional. 2 keeps 2, 2.5, 3… rooms."
          },
          "maxPricePerSqm": {
            "title": "Real estate: max price per m² (€)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional. For rentals, the monthly rent per m² (e.g. 15); for sales, the price per m² (e.g. 4000). Combine with a monitor for a flat alert."
          },
          "categoryId": {
            "title": "Category",
            "type": "string",
            "description": "Optional, for keyword searches. The category number, as in the \"c217\" of a Kleinanzeigen category URL: 161 electronics, 173 phones, 278 notebooks, 279 consoles, 217 bikes, 216 cars, 153 fashion, 80 home & garden, 81 bedroom, 88 living room, 17 kids & baby, 130 pets, 203 flats for rent, 196 flats for sale."
          },
          "sortBy": {
            "title": "Sort",
            "enum": [
              "newest",
              "price_asc",
              "price_desc"
            ],
            "type": "string",
            "description": "Order of the site's results for keyword searches: it decides which ads are read first when Max ads is reached.",
            "default": "newest"
          },
          "searchUrls": {
            "title": "…or paste search URLs",
            "type": "array",
            "description": "Any Kleinanzeigen search or category URL, with your filters already applied on the site. Can be combined with keywords.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "sellerType": {
            "title": "Seller type",
            "enum": [
              "any",
              "private",
              "commercial"
            ],
            "type": "string",
            "description": "Applies to keyword searches, and to real-estate search URLs (private landlord or agency is read from each ad card).",
            "default": "any"
          },
          "adType": {
            "title": "Ad type",
            "enum": [
              "offered",
              "wanted",
              "any"
            ],
            "type": "string",
            "description": "Applies to keyword searches.",
            "default": "offered"
          },
          "excludeKeywords": {
            "title": "Exclude ads containing",
            "type": "array",
            "description": "Drop ads whose title/description contains any of these words, e.g. \"defekt\", \"tausch\", \"suche\".",
            "items": {
              "type": "string"
            }
          },
          "excludeServices": {
            "title": "Leave out service ads",
            "type": "boolean",
            "description": "In searches for items, leave out the ads posted in service categories (repairs, \"Dienstleistungen\"), e.g. screen repair offers in an \"iphone 13\" search. Only when they are a minority of the results: a search for a service keeps them all. Pasted search URLs are never filtered.",
            "default": true
          },
          "onlyWithShipping": {
            "title": "Only ads with shipping",
            "type": "boolean",
            "description": "Keep only ads marked \"Versand möglich\" (asked to the site for keyword searches, so no page is wasted).",
            "default": false
          },
          "buyNowOnly": {
            "title": "Only \"Direkt kaufen\" ads",
            "type": "boolean",
            "description": "Keep only ads that can be bought and paid online with Kleinanzeigen's buyer protection.",
            "default": false
          },
          "onlyWithImages": {
            "title": "Only ads with photos",
            "type": "boolean",
            "description": "Drop ads without any photo.",
            "default": false
          },
          "excludeTopAds": {
            "title": "Exclude paid TOP ads",
            "type": "boolean",
            "description": "Drop promoted ads that are pinned at the top regardless of date.",
            "default": false
          },
          "maxAgeHours": {
            "title": "Max ad age (hours)",
            "minimum": 1,
            "type": "integer",
            "description": "Keep only ads posted in the last N hours, e.g. 24."
          },
          "maxItems": {
            "title": "Max ads to return",
            "minimum": 1,
            "type": "integer",
            "description": "You only pay for ads returned.",
            "default": 100
          },
          "maxPagesPerSearch": {
            "title": "Max pages per search",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "About 27 ads per page. Leave empty to read as many pages as needed to fill Max items (up to 50 pages); set it to cap the pages read per search."
          },
          "includeDetails": {
            "title": "Full ad details",
            "type": "boolean",
            "description": "Open every ad: full description, all images, condition, category, GPS, shipping, buy-now, view count and seller profile (type, member since, ads online, badges). Billed as a detailed ad.",
            "default": false
          },
          "includeViews": {
            "title": "Include view count",
            "type": "boolean",
            "description": "With full details: number of views and views per day (how hot an ad is).",
            "default": true
          },
          "dealAnalysis": {
            "title": "📊 Deal analysis",
            "type": "boolean",
            "description": "Compare every price with the market median of similar ads in the same search: marketMedianPrice, priceVsMarketPct and a 0–100 dealScore (100 = far below market). Free.",
            "default": true
          },
          "minDealScore": {
            "title": "Only deals with score ≥",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "E.g. 65 keeps ads priced ~15% or more below the market."
          },
          "monitorName": {
            "title": "🔔 Monitor name (only new ads & price drops)",
            "type": "string",
            "description": "Name this search and schedule the run: every run then returns only ads that are NEW or whose PRICE DROPPED since the previous run with the same name."
          },
          "alertOn": {
            "title": "Alert / output on",
            "enum": [
              "new_and_price_drops",
              "new",
              "price_drops"
            ],
            "type": "string",
            "description": "Which changes trigger an alert.",
            "default": "new_and_price_drops"
          },
          "telegramBotToken": {
            "title": "Telegram bot token",
            "type": "string",
            "description": "Get instant alerts with photo, price and deal score. Create a bot with @BotFather."
          },
          "telegramChatId": {
            "title": "Telegram chat ID",
            "type": "string",
            "description": "Your chat or channel ID (message @userinfobot to get yours)."
          },
          "discordWebhookUrl": {
            "title": "Discord webhook URL",
            "type": "string",
            "description": "Channel settings → Integrations → Webhooks."
          },
          "slackWebhookUrl": {
            "title": "Slack webhook URL",
            "type": "string",
            "description": "Incoming webhook URL."
          },
          "webhookUrl": {
            "title": "Custom webhook URL",
            "type": "string",
            "description": "Receives one JSON POST per run with all new items (Make, Zapier, n8n…)."
          },
          "maxNotifications": {
            "title": "Max alerts per run",
            "minimum": 1,
            "type": "integer",
            "description": "Extra items are summarized in one message.",
            "default": 30
          },
          "proxy": {
            "title": "Proxy",
            "type": "object",
            "description": "Default: fast datacenter proxy with automatic fallback to German residential IPs only when a request is blocked. You can pick your own proxy instead.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}