{ "openapi": "3.0.1", "info": { "title": "Trustpilot reviews scraper", "description": "Easily filter and extract thousands of reviews with data such as title, description, score, reviewer, country, company response, and much more from companies on Trustpilot.com and download them to multiple file formats.", "version": "3.0", "x-build-id": "6bLHwYYu8kqDuREJ4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/casper11515~trustpilot-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-casper11515-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/casper11515~trustpilot-reviews-scraper/runs": { "post": { "operationId": "runs-sync-casper11515-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/casper11515~trustpilot-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-casper11515-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", "required": [ "companyWebsite" ], "properties": { "companyWebsite": { "title": "Company website(s) or Trustpilot URL(s)", "type": "string", "description": "Enter either a single company domain (e.g., shopwagandtail.com), multiple domains separated by commas (e.g., coolshop.com, trustpilot.com, digitalocean.com), or direct Trustpilot URL(s) (e.g., https://www.trustpilot.com/review/www.dugood.org)" }, "contentToExtract": { "title": "Type of content to extract", "enum": [ "companyInformationAndReviews", "companyInformation", "reviews", "bulkCompanyInformation" ], "type": "string", "description": "Select the type of data to extract", "default": "companyInformationAndReviews" }, "startFromPageNumber": { "title": "Page to start scraping from", "minimum": 1, "type": "integer", "description": "You can specify the page number (eg. 7) that the scraper should start from. If this is left blank it will scrape from page 1", "default": 1 }, "endAtPageNumber": { "title": "Page to scrape last", "type": "integer", "description": "You can specify the page number (eg. 9) that the scraper should scrape last. If this is left set to 0 it will continue scraping to and including the last page", "default": 0 }, "sortBy": { "title": "Sorting", "enum": [ "recency", "relevancy" ], "type": "string", "description": "sort by recency or relevancy (don't enter something)", "default": "recency" }, "filterByStarRating": { "title": "Filter by star rating", "enum": [ "all", "1", "2", "3", "4", "5" ], "type": "string", "description": "Filter by 1,2,3,4,5 stars. Can not be combined. If left as all it will scrape reviews of all star ratings", "default": "all" }, "filterByLanguage": { "title": "Filter by language", "type": "string", "description": "Filter by language eg da, de, es and so on. Can not be combined", "default": "all" }, "filterByVerifiedReviews": { "title": "Filter by verified reviews", "type": "boolean", "description": "Filter by if review is verified. Enable to filter by only verified reviews. If it is not enabled then reviews will be both a mix of non verified and verified", "default": false }, "filterByCountryOfReviewers": { "title": "Filter by country of reviewers", "type": "string", "description": "Filter by if review was written by reviewers in a specific country. A list of country codes can be found here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, only 1 country code can be used at a time", "default": "" }, "filterByDatePeriod": { "title": "Filter by date the reviews were posted since", "enum": [ "any date", "last30days", "last3months", "last6months", "last12months" ], "type": "string", "description": "Filter reviews by when they were posted using Trustpilot's native date filters", "default": "any date" }, "Proxy configuration": { "title": "Select proxies to be used by your crawler", "type": "object", "description": "Select Apify proxies or set your own proxies" } } }, "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 } } } } } } } } } }