{ "openapi": "3.0.1", "info": { "title": "Trustpilot Scraper - Reviews, Ratings & Company Profiles", "description": "Scrape Trustpilot reviews and company profiles by domain, URL, keyword search or category. Trust score, star distribution, verification, contacts, review text, author, photos and replies. Filter by stars, language, date, verified. Export JSON, CSV, Excel.", "version": "0.1", "x-build-id": "2gl4QVJLpb0XZ6AJk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~trustpilot-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-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/scrapers_lat~trustpilot-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-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/scrapers_lat~trustpilot-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-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": { "companyDomains": { "title": "Company Domains", "type": "array", "description": "Company website domains to look up on Trustpilot, for example amazon.com, booking.com, hostinger.com. One company per entry.", "items": { "type": "string" } }, "trustpilotUrls": { "title": "Trustpilot Review URLs", "type": "array", "description": "Direct Trustpilot review page URLs, for example https://www.trustpilot.com/review/www.booking.com.", "items": { "type": "string" } }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "Find companies by name or keyword (Trustpilot company search). Each query returns the matching companies, up to Max Companies. Example: nike, hosting, insurance.", "items": { "type": "string" } }, "categories": { "title": "Category Browse", "type": "array", "description": "Browse companies listed under a Trustpilot category. Use the category slug from the URL, for example electronics_technology, travel_vacation, bank. Combine with Country to localize.", "items": { "type": "string" } }, "country": { "title": "Country (search / category)", "type": "string", "description": "Optional ISO 3166-1 alpha-2 country code to localize search and category browse results, for example US, GB, DE. Applies only to Search Queries and Category Browse." }, "maxCompanies": { "title": "Max Companies", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of companies to process across all inputs (direct list plus search and category discovery). Free plans are capped at 10." }, "withReviews": { "title": "Include Reviews", "type": "boolean", "description": "When enabled, collects individual customer reviews (author, rating, title, text, dates, verification, photos and company replies) for each company. Disable for company profile and rating summary only.", "default": true }, "maxReviews": { "title": "Max Reviews Per Company", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of reviews to collect per company (20 per page). Only used when Include Reviews is enabled. Free plans are capped at 10." }, "sort": { "title": "Review Sort Order", "enum": [ "recency", "relevance" ], "type": "string", "description": "Order reviews by most recent or by most relevant. Default is Trustpilot's default order." }, "stars": { "title": "Star Rating Filter", "type": "array", "description": "Only collect reviews with these star ratings. Select one or more of 1 to 5. 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" ] } }, "dateFilter": { "title": "Date Filter", "enum": [ "last30days", "last3months", "last6months", "last12months" ], "type": "string", "description": "Only collect reviews published within this recent window. Leave empty for all time." }, "language": { "title": "Review Language", "type": "string", "description": "Optional. Restrict reviews to a single language by ISO code (for example en, es, de, fr). Leave empty for all languages. For multiple languages use the Languages list." }, "languages": { "title": "Review Languages", "type": "array", "description": "Optional. Restrict reviews to one or more languages by ISO code, for example en, es, de. Leave empty for all languages.", "items": { "type": "string" } }, "verifiedReviewsOnly": { "title": "Verified Reviews Only", "type": "boolean", "description": "When enabled, collect only verified reviews.", "default": false }, "repliesOnly": { "title": "Reviews With Company Reply Only", "type": "boolean", "description": "When enabled, keep only reviews that have a company reply.", "default": false }, "reviewKeyword": { "title": "Keyword In Reviews", "type": "string", "description": "Optional. Only collect reviews whose text contains this keyword, for example delivery, refund, support." } } }, "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 } } } } } } } } } }