{ "openapi": "3.0.1", "info": { "title": "Trustpilot Scraper", "description": "Scrape Trustpilot company profiles, reviews, ratings, and category pages. Filter by star rating, date range, language, and verification status. Supports pagination for companies with thousands of reviews.", "version": "1.0", "x-build-id": "BQsuQ285vJtM6aH8t" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/magicfingers~trustpilot-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-magicfingers-trustpilot-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/magicfingers~trustpilot-scraper/runs": { "post": { "operationId": "runs-sync-magicfingers-trustpilot-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/magicfingers~trustpilot-scraper/run-sync": { "post": { "operationId": "run-sync-magicfingers-trustpilot-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", "required": [ "action" ], "properties": { "action": { "title": "Action", "enum": [ "scrapeReviews", "scrapeCompanyProfile", "searchCompanies", "scrapeCategory" ], "type": "string", "description": "What to scrape from Trustpilot.", "default": "scrapeReviews" }, "companyUrls": { "title": "Company URLs or Slugs", "type": "array", "description": "List of Trustpilot company URLs (e.g., https://www.trustpilot.com/review/example.com) or slugs (e.g., example.com). Used for scrapeReviews and scrapeCompanyProfile actions.", "items": { "type": "string" } }, "searchQuery": { "title": "Search Query", "type": "string", "description": "Keyword or company name to search for. Used with searchCompanies action." }, "categoryUrl": { "title": "Category URL", "type": "string", "description": "Trustpilot category page URL (e.g., https://www.trustpilot.com/categories/electronics_technology). Used with scrapeCategory action." }, "maxReviews": { "title": "Max Reviews Per Company", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum number of reviews to scrape per company. Set to 0 for all reviews.", "default": 5 }, "maxSearchResults": { "title": "Max Search/Category Results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of companies to return from search or category pages.", "default": 50 }, "filterByStars": { "title": "Filter by Star Rating", "type": "array", "description": "Only scrape reviews with these star ratings. Leave empty for all ratings.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ] }, "default": [] }, "filterDateFrom": { "title": "Filter Date From", "type": "string", "description": "Only scrape reviews posted on or after this date (YYYY-MM-DD)." }, "filterDateTo": { "title": "Filter Date To", "type": "string", "description": "Only scrape reviews posted on or before this date (YYYY-MM-DD)." }, "filterLanguage": { "title": "Filter by Language", "type": "string", "description": "Only scrape reviews in this language (e.g., 'en', 'de', 'fr'). Leave empty for all languages." }, "filterVerifiedOnly": { "title": "Verified Reviews Only", "type": "boolean", "description": "If enabled, only scrape reviews marked as verified.", "default": false }, "includeCompanyProfile": { "title": "Include Company Profile with Reviews", "type": "boolean", "description": "When scraping reviews, also output a company profile record.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Select proxies to use for scraping.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of concurrent page requests.", "default": 5 } } }, "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 } } } } } } } } } }