{ "openapi": "3.0.1", "info": { "title": "Trusted Shops Scraper: Shop Leads, Ratings, Reviews & Alerts", "description": "E-commerce leads and e-commerce reviews (shop reviews) from Trusted Shops: online shops (Germany, Austria, Switzerland, France, Spain, Italy, Netherlands, Poland, UK) by keyword with company, email, phone, Handelsregister, rating. Customer reviews (Bewertungen, avis clients), negative-review alerts.", "version": "0.1", "x-build-id": "uGcaoNUQWIBrQMjby" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/euroscrape~trusted-shops-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-euroscrape-trusted-shops-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~trusted-shops-scraper/runs": { "post": { "operationId": "runs-sync-euroscrape-trusted-shops-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~trusted-shops-scraper/run-sync": { "post": { "operationId": "run-sync-euroscrape-trusted-shops-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": { "searchTerms": { "title": "Find shops by keyword", "type": "array", "description": "What the shops sell, in the language of the market: \"fahrrad\", \"möbel\", \"bio\", \"chaussures\", \"zapatillas\"… One search per keyword and per country.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Markets to search. Each Trusted Shops market has its own shop directory.", "items": { "type": "string", "enum": [ "DE", "AT", "CH", "FR", "ES", "IT", "NL", "BE", "PL", "GB", "PT", "ALL" ], "enumTitles": [ "Germany", "Austria", "Switzerland", "France", "Spain", "Italy", "Netherlands", "Belgium", "Poland", "United Kingdom", "Portugal", "All markets at once" ] }, "default": [ "DE" ] }, "shops": { "title": "…or name the shops", "type": "array", "description": "Shop domains (bergfreunde.de), Trusted Shops profile URLs, or Trusted Shops IDs. Use this to export the reviews of your own shop or of competitors.", "items": { "type": "string" } }, "maxShopsPerSearch": { "title": "Maximum shops per keyword and country", "minimum": 1, "maximum": 10000, "type": "integer", "description": "The directory returns the best matches first. Up to 10,000 per keyword.", "default": 50 }, "minReviews": { "title": "Minimum number of reviews", "minimum": 0, "type": "integer", "description": "Keep only shops with at least this many reviews (all time). The number of reviews tracks the number of orders: 10,000+ is a large shop.", "default": 0 }, "minRating": { "title": "Minimum rating", "type": "string", "description": "Keep shops rated at least this much (1 to 5), e.g. 4.5." }, "maxRating": { "title": "Maximum rating", "type": "string", "description": "Keep shops rated at most this much, e.g. 4.5: most shops are rated higher, so this isolates the ones whose customers complain most." }, "certifiedOnly": { "title": "Certified shops only", "type": "boolean", "description": "Only shops that hold the Trusted Shops trustmark (paying members).", "default": false }, "membersOnly": { "title": "Trusted Shops customers only", "type": "boolean", "description": "Leave out the profiles Trusted Shops creates on its own for shops that are not its customers: they rarely carry an address, a phone or reviews.", "default": false }, "includeProfile": { "title": "Add the company profile", "type": "boolean", "description": "Legal company name, address, phone, email, commercial register, social links, star distribution and review volume over 12 months. One extra page per shop.", "default": true }, "includeSoleTraders": { "title": "Include contact details of sole traders", "type": "boolean", "description": "Off by default: when a shop is not run by a company (no legal form, no commercial register entry), its street, phone and email are left out, because they may be a private home. Turn on only if you have a lawful basis to process them.", "default": false }, "maxReviewsPerShop": { "title": "Reviews per shop", "minimum": 0, "maximum": 10000, "type": "integer", "description": "0 = no reviews. Most recent first; Trusted Shops publishes the last 12 months, up to 10,000 per shop.", "default": 0 }, "reviewStars": { "title": "Only these star ratings", "type": "array", "description": "Leave empty for all reviews. Pick 1 and 2 to read only the complaints.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "reviewsSince": { "title": "Only reviews since", "type": "string", "description": "Date (YYYY-MM-DD). Older reviews are skipped." }, "includeSummary": { "title": "Add a free summary", "type": "boolean", "description": "Largest shops, lowest rated shops, breakdown by country and category, review counts and reply rate per shop.", "default": true }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Set a name and schedule the Actor (e.g. daily): each run then delivers only what is new since the previous run — new shops matching your search, rating changes of the shops you named, new reviews — and can alert you. A day with nothing new costs the run start only." }, "alertMaxStars": { "title": "Alert on reviews up to", "minimum": 1, "maximum": 5, "type": "integer", "description": "A new review with this many stars or fewer triggers an alert (2 = one and two stars).", "default": 2 }, "telegramBotToken": { "title": "Telegram bot token", "type": "string", "description": "Alerts on Telegram: create a bot with @BotFather and paste its token." }, "telegramChatId": { "title": "Telegram chat ID", "type": "string", "description": "Your chat ID (send a message to your bot, then open api.telegram.org/bot/getUpdates)." }, "discordWebhookUrl": { "title": "Discord webhook URL", "type": "string", "description": "Alerts in a Discord channel: Channel settings → Integrations → Webhooks." }, "slackWebhookUrl": { "title": "Slack webhook URL", "type": "string", "description": "Alerts in Slack: create an Incoming Webhook for your channel." }, "webhookUrl": { "title": "Webhook URL (JSON)", "type": "string", "description": "Receives one POST per run with the new shops and the new low-rated reviews (Make, Zapier, n8n…)." }, "maxNotifications": { "title": "Maximum alerts per run", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum number of alert messages per run.", "default": 30 } } }, "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 } } } } } } } } } }