{ "openapi": "3.0.1", "info": { "title": "Trustpilot Reviews Scraper — Ratings, Reviews & Replies", "description": "Collect accessible Trustpilot reviews, ratings and company replies with filters and source diagnostics. Bulk export: JSON, CSV, Excel and API. Pay per result: from $0.1/1K reviews; start fee, usage extra.", "version": "1.8", "x-build-id": "p3oKOCmW4hkrNIOZL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apivault_labs~trustpilot-scraper-reviews-ratings-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apivault_labs-trustpilot-scraper-reviews-ratings-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/apivault_labs~trustpilot-scraper-reviews-ratings-api/runs": { "post": { "operationId": "runs-sync-apivault_labs-trustpilot-scraper-reviews-ratings-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/apivault_labs~trustpilot-scraper-reviews-ratings-api/run-sync": { "post": { "operationId": "run-sync-apivault_labs-trustpilot-scraper-reviews-ratings-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", "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Company domains, website URLs, Trustpilot company/review/user/search URLs, or brand names. At least one item here or in searchTerms is needed. Prefer an exact company profile to avoid brand ambiguity. The Console example is Canva; API calls without a target do not automatically select Canva.", "items": { "type": "string" } }, "maxReviews": { "title": "Maximum reviews per company", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Matching reviews per target, not per run; 0 removes only the review-count cap. maxPages, filters and public access still limit results. More targets or higher limits can increase review events and resource use.", "default": 20 }, "maxPages": { "title": "Maximum source pages per company", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Source pages per target, starting at startPage. Collection can stop earlier at the count limit or end of accessible results. Raising this value cannot bypass a login wall. Company-only mode returns after profile collection.", "default": 3 }, "contentMode": { "title": "Content mode", "enum": [ "companyInformationAndReviews", "reviews", "companyInformation", "bulkCompanyInformation" ], "type": "string", "description": "companyInformationAndReviews collects both datasets; reviews suppresses company rows; companyInformation and bulkCompanyInformation collect company profiles without review rows. Bulk mode still uses the supplied targets. Company summaries use a separate dataset.", "default": "companyInformationAndReviews" }, "searchTerms": { "title": "Brand or company names", "type": "array", "description": "Additional brand/company-name targets, merged with startUrls and deduplicated after normalization. Each search resolves a matching company rather than returning every search result. Prefer exact URLs when the brand name is ambiguous.", "items": { "type": "string" }, "default": [] }, "strictNameMatch": { "title": "Strict brand-name matching", "type": "boolean", "description": "For company-name resolution, reject results without a normalized name match. Matching is heuristic, not legal-entity verification. Does not restrict a supplied exact domain.", "default": false }, "dateRange": { "title": "Date range", "enum": [ "all", "last30days", "last3months", "last6months", "last12months" ], "type": "string", "description": "all, last30days, last3months, last6months, or last12months. Filters review publication time. Combined date filters use the latest cutoff, not an override hierarchy.", "default": "all" }, "lastDays": { "title": "Only the last N days", "minimum": 0, "maximum": 36500, "type": "integer", "description": "Rolling publication cutoff in days, recalculated at run time. 0 disables this filter. Combined with dateRange, startDate and active incremental state using the latest cutoff.", "default": 0 }, "startDate": { "title": "Published on or after", "type": "string", "description": "YYYY-MM-DD publication cutoff at UTC midnight; empty disables it. A malformed date is ignored by the runtime, so validate dates before calling. A later rolling or saved-state cutoff still applies.", "default": "" }, "filterStars": { "title": "Star ratings", "uniqueItems": true, "type": "array", "description": "String values 1, 2, 3, 4, 5; empty includes all ratings. Applied together with other filters. Filtering can return fewer than maxReviews within maxPages.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ] }, "default": [] }, "sampling": { "title": "Sampling when a limit is set", "enum": [ "balanced", "proportional" ], "type": "string", "description": "proportional keeps the collected source selection; it does not guarantee a statistically representative sample. balanced round-robins available ratings in order 1,5,2,4,3 before final date sorting. With no star filter it may collect up to max(100, maxReviews × 5) candidates within maxPages. It cannot produce absent ratings.", "default": "proportional" }, "filterLanguages": { "title": "Languages", "type": "array", "description": "Language codes such as en or de; empty allows all languages. Filters the review language, not the reviewer country. All selected filter categories must match.", "items": { "type": "string" }, "default": [] }, "filterCountries": { "title": "Reviewer countries", "type": "array", "description": "Reviewer country codes such as US or DE; empty allows all. This filters reviewer location, not company country. Missing country information cannot satisfy a selected country filter.", "items": { "type": "string" }, "default": [] }, "verifiedOnly": { "title": "Verified reviews only", "type": "boolean", "description": "Keep only reviews carrying a verified marker from Trustpilot. This is a source label, not independent verification by this Actor.", "default": false }, "repliesOnly": { "title": "Reviews with company replies only", "type": "boolean", "description": "Keep only reviews containing a company reply. This can reduce the sample and require more accessible pages to reach the requested limit.", "default": false }, "includeCompanyDetails": { "title": "Include company row", "type": "boolean", "description": "Controls separate Companies rows when collecting reviews. Omitted is treated as enabled; false suppresses them in combined mode. reviews mode suppresses them regardless; company-only modes force a company row.", "default": true }, "includeCompanyResponseMetrics": { "title": "Company response metrics", "type": "boolean", "description": "Adds responseMetrics to company rows. Computed over the collected review sample, not the entire company history. No effect when no company row is written.", "default": true }, "includeReviewInsights": { "title": "Add Review insights per company", "type": "boolean", "description": "Adds deterministic reviewInsights to company rows: rating/sentiment mix, languages and text heuristics. No AI call or separate insight event. No effect without company output. The schema/Console default is true; a raw runtime input omitting this boolean leaves it false, so agents should send true explicitly when needed.", "default": true }, "emitInputStatus": { "title": "Report inputs with no results", "type": "boolean", "description": "Writes invalid, failed, partial and no-review diagnostics to Input errors and INPUT_STATUS. Omitted is treated as true. false suppresses those records; SUMMARY remains essential for checking delivery.", "default": true }, "compact": { "title": "Compact review rows", "type": "boolean", "description": "Keep essential review columns. It does not change review count or per-review event rates. includeRaw can still append raw data.", "default": false }, "includeRaw": { "title": "Include complete raw review", "type": "boolean", "description": "Append the normalized source review object under raw. Its shape depends on the available source; do not rely on a fixed mobile-API payload. Increases row size, not the review-event count.", "default": false }, "startPage": { "title": "First source page", "minimum": 1, "maximum": 10000, "type": "integer", "description": "First requested source page. Use 1 for a first run. Together with maxPages this defines a bounded page window, not a durable resume cursor.", "default": 1 }, "sortBy": { "title": "Sort order", "enum": [ "auto", "recency", "relevance" ], "type": "string", "description": "auto and recency request newest reviews; relevance requests source relevance where supported. Compatibility paths may fall back to recency. Exported review rows are finally sorted by publication time, so this is source selection rather than a promised output ordering.", "default": "auto" }, "maxRetries": { "title": "Retries", "minimum": 0, "maximum": 8, "type": "integer", "description": "Retries for retryable requests. Although the schema allows 0, the current runtime normalizes 0 to 3; use 1–8 for an explicit nonzero count. Retries can increase time and resource use; they do not bypass access restrictions.", "default": 3 }, "timeout": { "title": "Request timeout (seconds)", "minimum": 10, "maximum": 180, "type": "integer", "description": "Per-request timeout in seconds, not the total Actor run timeout. Set the overall run timeout and spend cap separately in your client or Console.", "default": 45 }, "maxConcurrency": { "title": "Companies processed at once", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel target workers, 1–20. Higher concurrency can increase rate limiting and resource use; it does not increase review/page caps.", "default": 3 }, "incremental": { "title": "Only reviews newer than saved state", "type": "boolean", "description": "When true, exclude reviews at or before the saved publication timestamp for each domain (consumer profiles use consumer:USER_ID). Without prior state, the first run is a baseline. Timestamp tracking is not an exact review-ID ledger and can miss backdated or same-timestamp reviews; use sufficient limits.", "default": false }, "incrementalStateStoreId": { "title": "Persistent state store ID", "type": "string", "description": "Existing persistent Apify key-value store with READ/WRITE permission, used only when incremental is true. Reads and updates INCREMENTAL_STATE. Missing/unreadable state stops the run rather than silently rebilling history. Use a store you control; never copy another run storage ID." }, "incrementalState": { "title": "Incremental state (advanced)", "type": "object", "description": "Manual map of domain (or consumer:USER_ID) to RFC3339 latest publication timestamp. Used for filtering only with incremental true. When a persistent store is also supplied, the later timestamp per key wins. Read the new INCREMENTAL_STATE record for the next call; an ordinary new run store is not automatic cross-run persistence.", "default": {} }, "expandRegionalDomains": { "title": "Include regional profiles with the same brand name", "type": "boolean", "description": "Optional discovery of same-name regional company profiles. Discovery depends on source availability and can leave only the original target; it is not guaranteed coverage of all countries. Additional profiles can increase review events. Keep false for the first run.", "default": false }, "maxRegionalDomains": { "title": "Maximum regional profiles per brand", "minimum": 1, "maximum": 100, "type": "integer", "description": "Cap on discovered profiles per brand when regional expansion succeeds. Ignored when expandRegionalDomains is false. Direct review and consumer-profile targets are not expanded.", "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 }, "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 } } } } } } } } } }