{ "openapi": "3.0.1", "info": { "title": "Trustpilot Scraper", "description": "Scrape Trustpilot business profiles, ratings, and customer reviews. Extract structured data from any business listed on Trustpilot, or browse by category.", "version": "0.1", "x-build-id": "30QgTJ8S9mvzNgcqS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devon_gtme~trustpilot-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devon_gtme-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/devon_gtme~trustpilot-scraper/runs": { "post": { "operationId": "runs-sync-devon_gtme-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/devon_gtme~trustpilot-scraper/run-sync": { "post": { "operationId": "run-sync-devon_gtme-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", "properties": { "domains": { "title": "Business domains", "type": "array", "description": "One business per line — just the domain (e.g. wayfair.com, www.wayfair.com). The actor constructs the Trustpilot URL automatically. Easier than pasting full Trustpilot URLs.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (advanced)", "type": "array", "description": "Optional — paste full Trustpilot URLs. Useful for category pages (/categories/...) or country-prefixed URLs (/uk/review/...). For business pages, prefer the 'Business domains' field above.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "scrapeMode": { "title": "Scrape Mode", "enum": [ "listing", "full" ], "type": "string", "description": "\"listing\" extracts data from category cards only (fast). \"full\" visits each business page for complete data + reviews.", "default": "full" }, "includeReviews": { "title": "Include Reviews", "type": "boolean", "description": "Extract individual reviews for each business. Only used in full mode. Increases run time.", "default": true }, "maxReviewsPerBusiness": { "title": "Max reviews per business", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum reviews to scrape per business. 0 = no limit (paginate until last page). Only used when Include Reviews is enabled.", "default": 20 }, "reviewStartPage": { "title": "Review start page", "minimum": 1, "maximum": 1000, "type": "integer", "description": "First review page to scrape (1 = newest reviews). Trustpilot orders reviews newest-first, so reviewStartPage=2 skips the most recent 20 reviews.", "default": 1 }, "reviewEndPage": { "title": "Review end page", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Last review page to scrape. 0 = no limit. Use with reviewStartPage to scrape a window of reviews by recency.", "default": 0 }, "starsFilter": { "title": "Star Filter", "uniqueItems": true, "type": "array", "description": "Only fetch reviews with these star ratings, e.g. [1] for 1-star only or [1,2] for 1-2 star. Empty = all stars. Uses Trustpilot's native ?stars= URL filter (server-side, efficient).", "default": [], "items": { "type": "string" } }, "reviewsSince": { "title": "Reviews Since (YYYY-MM-DD)", "type": "string", "description": "Only keep reviews published on or after this date (ISO format YYYY-MM-DD). Empty = no filter.", "default": "" }, "reviewsUntil": { "title": "Reviews Until (YYYY-MM-DD)", "type": "string", "description": "Only keep reviews published on or before this date (ISO format YYYY-MM-DD). Empty = no filter.", "default": "" }, "minReviewRating": { "title": "Min Review Rating (legacy)", "minimum": 0, "maximum": 5, "type": "integer", "description": "Only keep reviews with star rating >= this value (1-5). 0 = no filter. Prefer starsFilter for new use.", "default": 0 }, "endPage": { "title": "End Page", "minimum": 0, "maximum": 100, "type": "integer", "description": "Stop category listing pagination after this page number. 0 = no limit.", "default": 0 }, "maxItems": { "title": "Max Items", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Maximum total businesses to scrape. 0 = no limit.", "default": 0 }, "proxy": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Trustpilot has Cloudflare/PerimeterX protection — residential proxies required for reliability.", "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 } } }, "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 } } } } } } } } } }