{ "openapi": "3.0.1", "info": { "title": "Trustpilot Reviews Scraper", "description": "Scrape Trustpilot reviews for any company: rating, text, author, country, dates, verification, company replies and TrustScore. Filter by stars, language and date. Deep mode goes past the 200-review limit. Export CSV, Excel or JSON.", "version": "0.1", "x-build-id": "JndMihrazDqnxkKrl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bozomalabs~trustpilot-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bozomalabs-trustpilot-reviews-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/bozomalabs~trustpilot-reviews-scraper/runs": { "post": { "operationId": "runs-sync-bozomalabs-trustpilot-reviews-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/bozomalabs~trustpilot-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-bozomalabs-trustpilot-reviews-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": { "startUrls": { "title": "Trustpilot review page URLs", "type": "array", "description": "Trustpilot company pages, for example https://www.trustpilot.com/review/www.etsy.com. Filters already in the URL (stars, languages, verified, replies) are kept.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "companyDomains": { "title": "Company domains", "type": "array", "description": "Or just type company domains as Trustpilot lists them, for example monzo.com or www.hellofresh.com.", "items": { "type": "string" } }, "maxReviewsPerCompany": { "title": "Max reviews per company", "minimum": 0, "type": "integer", "description": "Stop after this many reviews for each company. 0 means no limit.", "default": 200 }, "stars": { "title": "Star ratings", "type": "array", "description": "Only keep reviews with these ratings. Leave empty for all ratings.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "language": { "title": "Review language", "type": "string", "description": "Trustpilot language code such as en, de, fr or da, or 'all' for every language.", "default": "all" }, "sort": { "title": "Sort", "enum": [ "recency", "relevance" ], "type": "string", "description": "Most recent lets the Actor stop early when you set 'Reviews from'.", "default": "recency" }, "dateFrom": { "title": "Reviews from (date)", "type": "string", "description": "Only keep reviews published on or after this date (YYYY-MM-DD)." }, "verifiedOnly": { "title": "Verified reviews only", "type": "boolean", "description": "Only reviews Trustpilot marks as verified.", "default": false }, "withRepliesOnly": { "title": "Only reviews with a company reply", "type": "boolean", "description": "Only reviews the company has answered.", "default": false }, "includeCompanyReplies": { "title": "Include company replies", "type": "boolean", "description": "Add the company's reply text and reply date to each review.", "default": true }, "deepMode": { "title": "Deep mode (past the 200 review limit)", "type": "boolean", "description": "Trustpilot shows signed-out visitors 10 pages (200 reviews) per list. Deep mode reads each star rating as its own list and removes duplicates, so you can get up to about 1,000 reviews per language list.", "default": false }, "paceMs": { "title": "Delay between pages (ms)", "minimum": 0, "type": "integer", "description": "Pause between review pages. Raise it if you see blocks.", "default": 800 }, "maxConcurrency": { "title": "Companies in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many companies to scrape at the same time.", "default": 2 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential Apify Proxy is required: Trustpilot blocks datacenter IPs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }