{
"openapi": "3.0.1",
"info": {
"title": "Trustpilot Reviews Scraper",
"description": "Scrape Trustpilot company reviews reliably, past AWS WAF bot protection. Filter by star rating, date range, language, and verification status.",
"version": "0.0",
"x-build-id": "nKYLB65kwiulp9Boq"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/roomi_roomi~trustpilot-reviews-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-roomi_roomi-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/roomi_roomi~trustpilot-reviews-scraper/runs": {
"post": {
"operationId": "runs-sync-roomi_roomi-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/roomi_roomi~trustpilot-reviews-scraper/run-sync": {
"post": {
"operationId": "run-sync-roomi_roomi-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": [
"companies"
],
"properties": {
"companies": {
"title": "Companies",
"minItems": 1,
"type": "array",
"description": "Trustpilot company domains or full review URLs, one per line. Use the identifying domain exactly as it appears in the company's Trustpilot URL, e.g. www.amazon.com or https://www.trustpilot.com/review/www.amazon.com.",
"default": [
"www.amazon.com"
],
"items": {
"type": "string"
}
},
"maxReviewsPerCompany": {
"title": "Max reviews per company",
"minimum": 0,
"type": "integer",
"description": "Maximum number of reviews to scrape per company (after filters are applied). Set to 0 to scrape all matching reviews — this can be expensive for large companies, so start small.",
"default": 10
},
"stars": {
"title": "Star ratings",
"uniqueItems": true,
"type": "array",
"description": "Only scrape reviews with these star ratings. Leave empty to include all ratings.",
"items": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"enumTitles": [
"1 star",
"2 stars",
"3 stars",
"4 stars",
"5 stars"
]
},
"default": []
},
"dateRange": {
"title": "Date range",
"enum": [
"all",
"last30days",
"last3months",
"last6months",
"last12months"
],
"type": "string",
"description": "Only scrape reviews experienced within this time window.",
"default": "all"
},
"language": {
"title": "Review language",
"type": "string",
"description": "ISO language code to filter reviews by (e.g. \"en\", \"de\", \"fr\"). Use \"all\" to include reviews in every language.",
"default": "en"
},
"verifiedOnly": {
"title": "Verified reviews only",
"type": "boolean",
"description": "Only scrape reviews Trustpilot has verified (e.g. verified invitation or verified order).",
"default": false
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Apify Proxy configuration. Datacenter proxies (the default) are recommended — they keep this Actor cheap to run and are sufficient for Trustpilot.",
"default": {
"useApifyProxy": true
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}