{ "openapi": "3.0.1", "info": { "title": "Trustpilot Scraper — Reviews, TrustScore & Companies", "description": "Scrape Trustpilot reviews past the 200-review page limit, company profiles with TrustScore, star distribution and contact details, and category or search listings.", "version": "0.1", "x-build-id": "x08LrWU8gBQniRfez" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~trustpilot-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-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/tortuga~trustpilot-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-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/tortuga~trustpilot-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Trustpilot company pages (https://www.trustpilot.com/review/www.amazon.com), category pages (https://www.trustpilot.com/categories/electronics_technology) or search pages (https://www.trustpilot.com/search?query=pizza). Filters in a company URL copied from the browser (stars, languages, date, sort, verified, replies, search) are kept and override the filter fields below. Category and search pages are paginated automatically; in Reviews or Company profiles mode every company on them is processed.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "companyDomains": { "title": "Company domains", "type": "array", "description": "Shortcut for company pages: the domain Trustpilot uses for the company, e.g. \"www.amazon.com\" or \"monzo.com\" (redirects are followed).", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Company names or keywords to look up with Trustpilot's company search (same as https://www.trustpilot.com/search?query=...).", "items": { "type": "string" } }, "mode": { "title": "What to scrape", "enum": [ "reviews", "companies", "listing" ], "type": "string", "description": "reviews: one item per review (default). companies: one profile per company (TrustScore, review count, star distribution, categories, website, contact details, reply rate, AI summary). listing: one card per company on category or search pages (TrustScore, review count, website, email, phone, address, categories).", "default": "reviews" }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many items in total (reviews, profiles or listing cards across all inputs). No page is requested for items that would not fit.", "default": 100 }, "maxReviewsPerCompany": { "title": "Max reviews per company", "minimum": 1, "type": "integer", "description": "Reviews mode: cap per company. Trustpilot shows visitors 200 reviews per filter combination; above 200 the actor splits the list by star rating and review language (and, for very large slices, also reads the relevance order, verified-only, replied-only and date-window views) and merges the results without duplicates.", "default": 100 }, "includeCompanyProfile": { "title": "Also save the company profile", "type": "boolean", "description": "Reviews mode: also save one company profile item per company (charged as a company profile). It comes from the first review page, so it needs no extra request.", "default": false }, "stars": { "title": "Only these star ratings", "type": "array", "description": "Optional: keep only reviews with these star ratings, e.g. 1 and 2 for complaints. Applied by Trustpilot, so you do not pay for reviews you do not want. Empty = all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] }, "default": [] }, "language": { "title": "Review language", "type": "string", "description": "Two-letter language code (en, de, fr, it, es, nl, da, sv, ...) or \"all\" (default). Note that Trustpilot's own site shows only English reviews by default; this actor asks for all languages unless you set one.", "default": "all" }, "datePosted": { "title": "Date posted", "enum": [ "all", "last30days", "last3months", "last6months", "last12months" ], "type": "string", "description": "Only reviews posted in this period.", "default": "all" }, "sort": { "title": "Sort reviews", "enum": [ "recency", "relevance" ], "type": "string", "description": "Order in which reviews are collected (matters whenever a cap is set).", "default": "recency" }, "verifiedOnly": { "title": "Verified reviews only", "type": "boolean", "description": "Only reviews Trustpilot labels as verified.", "default": false }, "withRepliesOnly": { "title": "Reviews with a company reply only", "type": "boolean", "description": "Only reviews the company has replied to.", "default": false }, "reviewKeyword": { "title": "Reviews mentioning", "type": "string", "description": "Optional: only reviews containing this word or phrase (Trustpilot's own review search)." }, "onlyNewOrChanged": { "title": "Only new or changed items", "type": "boolean", "description": "Remember what earlier runs of this input returned and output only what is new or changed. Reviews mode: only reviews no earlier run output, read newest first (the sort is set to Most recent) and paging stops as soon as a page ends with reviews from an earlier run, so a daily run of one company usually costs one request; the company profile is output on the first run only. Companies and listing modes: only companies that are new or whose TrustScore, stars or closed/alert status changed (review counts are not watched). Use with a Schedule; unchanged items are not charged. Combine with Date posted to bound the first run.", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name for this watch, so several schedules on the same search stay separate; defaults to a key derived from the search input. Only used with Only new or changed items." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Trustpilot blocks datacenter and residential IPs with a \"Verifying Connection\" page, so the default is Apify's UNBLOCKER proxy group. Each successful Unblocker request is billed by Apify as 10 proxy units (about $0.0015) to your account; one request returns 20 reviews or 10-20 listing cards, i.e. roughly $0.08-0.15 of proxy per 1,000 reviews. Failed requests are free.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "UNBLOCKER" ] } } } }, "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 } } } } } } } } } }