{
"openapi": "3.0.1",
"info": {
"title": "Kleinanzeigen Nachrichten API - Senden & Empfangen",
"description": "Sende Nachrichten an Kleinanzeigen-Inserate, lies dein Postfach und überwache neue Antworten automatisch. Batch-Versand an bis zu 10 Anzeigen pro Lauf, vollständige Konversationen, Telegram-Benachrichtigungen. Nutzt dein eigenes Konto.",
"version": "0.0",
"x-build-id": "BnZMXmiXa1dsQp5ky"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/clearpath~kleinanzeigen-message-api/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-clearpath-kleinanzeigen-message-api",
"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/clearpath~kleinanzeigen-message-api/runs": {
"post": {
"operationId": "runs-sync-clearpath-kleinanzeigen-message-api",
"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/clearpath~kleinanzeigen-message-api/run-sync": {
"post": {
"operationId": "run-sync-clearpath-kleinanzeigen-message-api",
"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",
"required": [
"operation",
"kaEmail"
],
"properties": {
"operation": {
"title": "Aktion",
"enum": [
"login",
"verify2fa",
"send",
"inbox",
"conversation",
"monitor"
],
"type": "string",
"description": "Was der Lauf tun soll:
• Anmelden: ein Kleinanzeigen-Konto onboarden
• Bestätigungscode einlösen: Anmeldung mit dem SMS-Code oder dem Link aus der Bestätigungs-E-Mail abschließen
• Nachricht senden: eine Nachricht an eine oder mehrere Anzeigen senden
• Postfach abrufen: alle Konversationen abrufen
• Konversation abrufen: den vollständigen Verlauf einer Konversation abrufen
• Neue Nachrichten überwachen: regelmäßig auf neue eingehende Nachrichten prüfen"
},
"kaEmail": {
"title": "Kleinanzeigen E-Mail",
"type": "string",
"description": "Die E-Mail-Adresse des Kleinanzeigen-Kontos, mit dem gearbeitet werden soll. Für alle Aktionen erforderlich.
Mit der voreingestellten Adresse demo@example.com kannst du den Actor unverbindlich mit Beispieldaten testen, ganz ohne eigenes Konto."
},
"kaPassword": {
"title": "Passwort",
"type": "string",
"description": "Das Passwort des Kleinanzeigen-Kontos. Nur für die Aktion Anmelden erforderlich."
},
"verificationCode": {
"title": "Bestätigungscode (SMS)",
"type": "string",
"description": "Der 6-stellige SMS-Code, den Kleinanzeigen beim Anmelden an deine Handynummer sendet. Nur für die Aktion Bestätigungscode einlösen. Wird bevorzugt verwendet, falls du auch einen Bestätigungslink einträgst."
},
"verificationUrl": {
"title": "Bestätigungslink",
"type": "string",
"description": "Der vollständige Link aus der Bestätigungs-E-Mail, die Kleinanzeigen nach der Anmeldung verschickt hat. Nur für die Aktion Bestätigungscode einlösen, als Alternative zum SMS-Code."
},
"adUrl": {
"title": "Anzeigen-URL",
"type": "string",
"description": "Link zur Kleinanzeigen-Anzeige, an die die Nachricht gesendet werden soll.
Format: https://www.kleinanzeigen.de/s-anzeige/...
Nur für die Aktion Nachricht senden relevant."
},
"adUrls": {
"title": "Mehrere Anzeigen (Batch-Versand)",
"maxItems": 10,
"type": "array",
"description": "Die gleiche Nachricht an mehrere Anzeigen gleichzeitig senden. Überschreibt die einzelne Anzeigen-URL oben, wenn gesetzt. Maximal 10 Anzeigen pro Lauf.",
"items": {
"type": "string"
}
},
"message": {
"title": "Nachricht",
"type": "string",
"description": "Der Nachrichtentext, der an den bzw. die Anbieter gesendet wird. Erforderlich für die Aktion Nachricht senden."
},
"conversationId": {
"title": "Konversations-ID",
"type": "string",
"description": "Die ID der Konversation, deren vollständiger Verlauf abgerufen werden soll. Zu finden im Feld conversation_id eines Ergebnisses der Aktion Postfach abrufen. Erforderlich für die Aktion Konversation abrufen."
},
"messageOrder": {
"title": "Reihenfolge der Nachrichten",
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Chronologische Reihenfolge der zurückgegebenen Nachrichten. Nur für die Aktion Konversation abrufen.",
"default": "asc"
},
"inboxLimit": {
"title": "Max. Postfach-Einträge",
"minimum": 1,
"maximum": 500,
"type": "integer",
"description": "Maximale Anzahl an Konversationen bzw. Nachrichten, die abgerufen werden.",
"default": 50
},
"telegramUserId": {
"title": "Telegram Nutzer-ID",
"type": "string",
"description": "Deine numerische Telegram-ID für Benachrichtigungen über neue Nachrichten, z. B. über den Bot @userinfobot ermittelbar. Optional, nur für die Aktion Neue Nachrichten überwachen."
},
"telegramNotificationLimit": {
"title": "Max. Benachrichtigungen",
"minimum": 1,
"maximum": 50,
"type": "integer",
"description": "Obergrenze für die Anzahl an Telegram-Benachrichtigungen pro Lauf, um bei vielen neuen Nachrichten Spam zu vermeiden.",
"default": 10
}
}
},
"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
}
}
}
}
}
}
}
}
}
}