{ "openapi": "3.0.1", "info": { "title": "Kleinanzeigen Scraper โ€” German Classifieds", "description": "Scrape classified listings from Kleinanzeigen.de โ€” prices, locations, images, descriptions, and seller contacts including phone and email. Filter by keyword, category and location; incremental runs return only new listings.", "version": "0.1", "x-build-id": "LkYGq1ItqlQEDYc2K" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/blackfalcondata~kleinanzeigen-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-blackfalcondata-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/blackfalcondata~kleinanzeigen-scraper/runs": { "post": { "operationId": "runs-sync-blackfalcondata-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/blackfalcondata~kleinanzeigen-scraper/run-sync": { "post": { "operationId": "run-sync-blackfalcondata-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": { "query": { "title": "๐Ÿ” Search Term", "type": "string", "description": "Single keyword or phrase (e.g. 'iPhone', 'sofa', 'Fahrrad'). For multiple searches in one run, use the `queries` array below." }, "queries": { "title": "๐Ÿ”Ž Multiple Search Terms", "type": "array", "description": "Run multiple keyword searches in one go โ€” e.g. `[\"laptop\", \"iPad\", \"AirPods\"]`. Results from all searches are merged and deduplicated by listing ID. Filters below (category, location, price, etc.) apply to all queries. Takes precedence over the single `query` field.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "๐Ÿ”— Start URLs (paste-mode)", "type": "array", "description": "Paste one or more Kleinanzeigen.de search-result URLs. Build the filters you want in your browser, copy the URL, and paste here. Each URL is paginated; results are merged and deduplicated. Takes precedence over `query`, `queries`, and all filter inputs. The legacy `searchUrls` field name is still accepted for backward compatibility.", "default": [], "items": { "type": "string" } }, "watchSellerIds": { "title": "๐Ÿ‘๏ธ Seller Watchlist", "type": "array", "description": "Track specific sellers by their numeric seller ID โ€” paste the IDs (or full seller-inventory URLs) and the run returns each seller's current listings. Takes precedence over search term, queries, and Start URLs. Combine with โ™ป๏ธ Incremental Mode to get only a seller's new or changed listings each run.", "default": [], "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "๐Ÿ“Š Max Results Per Query", "minimum": 0, "type": "integer", "description": "Cap per individual search when running multiple queries via `queries`. 0 = use the global Max Results for every query. Useful for balanced sampling across diverse searches.", "default": 0 }, "category": { "title": "๐Ÿ“ Category", "enum": [ "all", "autos", "elektronik", "mietwohnungen", "haus_garten", "jobs", "familie_kind_baby", "mode_beauty", "eintrittskarten_tickets" ], "type": "string", "description": "Filter by Kleinanzeigen category.", "default": "all" }, "location": { "title": "๐Ÿ“ Location", "type": "string", "description": "City name or postal code to search within (e.g. 'Berlin', 'Mรผnchen', '10115'). Leave blank to search all of Germany." }, "radius": { "title": "๐Ÿ“ Search Radius (km)", "minimum": 0, "maximum": 200, "type": "integer", "description": "Proximity radius around the specified location in kilometres. Requires Location to be set. 0 = exact city match. Kleinanzeigen uses preset steps (5, 10, 20, 30, 50, 100, 150, 200 km) and snaps to the nearest.", "default": 0 }, "condition": { "title": "โœจ Condition", "enum": [ "all", "neu", "sehr_gut", "gut", "in_ordnung", "defekt" ], "type": "string", "description": "Filter by item condition.", "default": "all" }, "sellerType": { "title": "๐Ÿ‘ค Seller Type", "enum": [ "all", "privat", "gewerblich" ], "type": "string", "description": "Filter by seller type.", "default": "all" }, "shipping": { "title": "๐Ÿ“ฆ Shipping", "enum": [ "all", "ja", "nein" ], "type": "string", "description": "Filter by shipping availability.", "default": "all" }, "adType": { "title": "๐Ÿ“‹ Listing Type", "enum": [ "angebote", "gesuche" ], "type": "string", "description": "Listing type: offers for sale, or wanted ads.", "default": "angebote" }, "priceMin": { "title": "๐Ÿ’ฐ Min Price (EUR)", "minimum": 0, "type": "integer", "description": "Minimum price filter.", "default": 0 }, "priceMax": { "title": "๐Ÿ’ฐ Max Price (EUR)", "minimum": 0, "type": "integer", "description": "Maximum price filter. 0 = no limit.", "default": 0 }, "sortBy": { "title": "๐Ÿ”€ Sort By", "enum": [ "newest", "price_asc", "price_desc" ], "type": "string", "description": "Sort order for results.", "default": "newest" }, "whatAnd": { "title": "๐Ÿงฉ Must Include All Words", "type": "array", "description": "Keep only listings whose title (and description, when ๐Ÿ“„ Enrichment is on) contains EVERY word listed here. Accent- and case-insensitive. Example: [\"carbon\", \"rennrad\"] keeps only carbon road bikes. Applied after fetching, so the returned count may be lower than Max Results.", "default": [], "items": { "type": "string" } }, "whatExclude": { "title": "๐Ÿšซ Exclude Words", "type": "array", "description": "Drop listings whose title (and description, when ๐Ÿ“„ Enrichment is on) contains ANY of these words. Accent- and case-insensitive. Example: [\"defekt\", \"bastler\"] removes broken / for-parts listings. Applied after fetching, so the returned count may be lower than Max Results.", "default": [], "items": { "type": "string" } }, "postedWithin": { "title": "๐Ÿ•’ Posted Within", "enum": [ "all", "today", "week", "month" ], "type": "string", "description": "Keep only listings posted within this time window. 'Any time' applies no date filter. Applied after fetching, so the returned count may be lower than Max Results.", "default": "all" }, "attributeFilters": { "title": "๐ŸŽ›๏ธ Attribute Filters", "type": "object", "description": "Advanced per-category attribute filters โ€” narrow a search by the same options the listing site itself offers (brand, fuel type, mileage, rooms, size, and so on). The easiest way to filter: set the options you want in your browser on the site, copy the search-result URL, and paste it into ๐Ÿ”— Start URLs โ€” every filter is captured automatically. To set them here instead, provide a map of `\"category.attribute\": \"value\"`. Values are the site's own lowercase tokens (e.g. `diesel`, not `Diesel`); comma-separate to match any of several (OR); use `min,max` for numeric ranges (either side optional). Requires the matching ๐Ÿ“ Category to be set. Examples โ€” cars: `{ \"autos.marke\": \"bmw\", \"autos.fuel\": \"diesel\", \"autos.km\": \"0,100000\" }`; apartment rental: `{ \"wohnung_mieten.zimmer\": \"2,\", \"wohnung_mieten.qm\": \"50,\" }`. Unrecognized values are sent as-is and may simply not narrow results.", "default": {} }, "maxResults": { "title": "๐Ÿ’ฏ Max Results", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum total listings to return across all searches. 0 = unlimited.", "default": 25 }, "incremental": { "title": "โ™ป๏ธ Incremental Mode", "type": "boolean", "description": "Only return new or changed listings since the last run. State is saved between runs and scoped per query and category.", "default": false }, "stateKey": { "title": "๐Ÿ”‘ State Key", "type": "string", "description": "Custom key for incremental state storage. Defaults to a key derived from your search query and category. Use to share state across runs with minor input variations." }, "emitUnchanged": { "title": "๐Ÿ“ค Emit Unchanged Listings", "type": "boolean", "description": "In โ™ป๏ธ Incremental Mode, also output listings that haven't changed since the last run (normally skipped). Off by default.", "default": false }, "emitExpired": { "title": "๐Ÿ—‘๏ธ Emit Expired Listings", "type": "boolean", "description": "In โ™ป๏ธ Incremental Mode, output a stub row (changeType=EXPIRED) for listings that were present in a previous run but are now gone. On by default.", "default": true }, "skipReposts": { "title": "๐Ÿ” Skip Reposts", "type": "boolean", "description": "In โ™ป๏ธ Incremental Mode, suppress listings that look like a re-post of a previously expired one (same title, price, and location under a new ID). Off by default.", "default": false }, "includeDetails": { "title": "๐Ÿ“‹ Include Full Listing Details", "type": "boolean", "description": "Fetch the full listing page for each result to add description, images, category path, attributes, and more. Produces richer output but takes longer.", "default": true }, "includeSellerProfile": { "title": "๐Ÿ‘ค Include Seller Profile", "type": "boolean", "description": "Fetch extra detail for each unique seller to add reputation badges and the seller's active-ads count. Adds one request per unique seller (a small per-seller charge applies) and increases run time.", "default": false }, "includePhone": { "title": "๐Ÿ“ž Include Phone Number", "type": "boolean", "description": "Resolve and include the seller's contact phone number for each listing. Requires an additional request per listing.", "default": false }, "descriptionMaxLength": { "title": "โœ‚๏ธ Description Max Length", "minimum": 0, "type": "integer", "description": "Truncate listing descriptions to N characters. 0 = no truncation.", "default": 0 }, "descriptionFormat": { "title": "Description format", "enum": [ "all", "text", "html", "markdown" ], "type": "string", "description": "Pick a single description representation. `all` keeps every variant; `text` / `html` / `markdown` drops the others.", "default": "all" }, "compact": { "title": "๐Ÿ“ฆ Compact Output", "type": "boolean", "description": "Return only the most essential fields (for AI-agent and MCP workflows).", "default": false }, "omitNulls": { "title": "๐Ÿงน Omit Null / Empty Fields", "type": "boolean", "description": "Drop null, empty string, empty array, and empty object fields from each output row. Reduces dataset size and removes noise for LLM pipelines. Keeps `false` and `0` as valid values. Default on โ€” disable if you need a fixed schema where every row has every documented field.", "default": true }, "excludeEmptyFields": { "title": "Exclude empty fields from output", "type": "boolean", "description": "Drop null, empty-string, and empty-array fields from each record before push. Smaller payloads for AI agents and dashboards.", "default": false }, "telegramToken": { "title": "๐Ÿ”‘ Telegram Bot Token", "type": "string", "description": "Telegram bot token (from @BotFather). Required for Telegram notifications." }, "telegramChatId": { "title": "๐Ÿ’ฌ Telegram Chat ID", "type": "string", "description": "Telegram chat or channel ID (e.g. \"-100123456789\"). Required when telegramToken is set." }, "discordWebhookUrl": { "title": "๐ŸŽฎ Discord Webhook URL", "type": "string", "description": "Discord incoming webhook URL. Server Settings โ†’ Integrations โ†’ Webhooks โ†’ New Webhook." }, "slackWebhookUrl": { "title": "๐Ÿ’ผ Slack Webhook URL", "type": "string", "description": "Slack incoming webhook URL. api.slack.com/messaging/webhooks." }, "whatsappPhoneNumberId": { "title": "๐Ÿ“ž WhatsApp Phone Number ID", "type": "string", "description": "Your WhatsApp Business phone-number ID (numeric, from Meta dashboard). Required when whatsappAccessToken is set." }, "whatsappAccessToken": { "title": "๐Ÿ“ฑ WhatsApp Access Token", "type": "string", "description": "WhatsApp Cloud API permanent access token (System User token from Meta Business). Recipient must have messaged the business number within the last 24 h." }, "whatsappTo": { "title": "๐Ÿ“ฒ WhatsApp Recipient", "type": "string", "description": "Recipient phone in E.164 format without + (e.g. \"436641234567\"). Recipient must have messaged your business number within the last 24 h." }, "webhookUrl": { "title": "๐Ÿช Generic Webhook URL", "type": "string", "description": "Receives a JSON POST with {metadata, items} after each run. Works with n8n, Make, Zapier, and custom backends." }, "webhookHeaders": { "title": "๐Ÿ“‹ Webhook Headers", "type": "object", "description": "Optional JSON object of custom headers (e.g. {\"Authorization\":\"Bearer ...\"})." }, "notificationLimit": { "title": "๐Ÿ“Š Max Listings Per Notification", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of listings included in each notification message (1โ€“20).", "default": 5 }, "notifyOnlyChanges": { "title": "๐Ÿ”„ Notify Only New/Updated", "type": "boolean", "description": "When Incremental Mode is on, only send notifications for NEW and UPDATED listings. Has no effect outside incremental mode.", "default": false }, "appConnector": { "title": "Send results to Notion (or another connected app)", "type": "string", "description": "Optional. Pick a connected app under Settings โ†’ API & Integrations to receive your results. Notion is supported today; other connectors are best-effort as Apify expands its catalog." }, "mcpIssueTeam": { "title": "Issue tracker team", "type": "string", "description": "Only when the connected app is an issue tracker: the team (name or ID) the summary issue is created under, if that app requires one." } } }, "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 } } } } } } } } } }