{ "openapi": "3.0.1", "info": { "title": "Trustpilot Universal Scraper", "description": "⚡ Scrape unlimited Trustpilot reviews for any company! Paste a domain or review URL, filter by stars, language, period or keywords, and instantly get rich, structured data — reviews, ratings, replies, TrustScores — for reputation monitoring, competitor analysis or lead generation.", "version": "0.1", "x-build-id": "uXEI6sYrDi6em74kM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapifier~trustpilot-universal-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapifier-trustpilot-universal-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/scrapifier~trustpilot-universal-scraper/runs": { "post": { "operationId": "runs-sync-scrapifier-trustpilot-universal-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/scrapifier~trustpilot-universal-scraper/run-sync": { "post": { "operationId": "run-sync-scrapifier-trustpilot-universal-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": [ "company_urls" ], "properties": { "company_urls": { "title": "Companies / URLs *", "type": "array", "description": "One item per row. Each can be:\n- a **company name** (`amazon`) — resolved to the top Trustpilot match,\n- a **domain** as shown on Trustpilot (`www.amazon.com`),\n- a **company website URL** (`https://www.amazon.com`),\n- a **Trustpilot review URL** (`https://www.trustpilot.com/review/…` — its own query filters are kept),\n- a **reviewer profile URL** (`https://www.trustpilot.com/users/{id}` — scrapes the reviews that user wrote).\nRegional Trustpilot hosts (fr., uk., de.…) work too.", "items": { "type": "string" } }, "stars": { "title": "Star ratings", "type": "array", "description": "Only reviews with these ratings. Empty = all ratings.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1", "2", "3", "4", "5" ] } }, "languages": { "title": "Languages", "type": "array", "description": "Pick one or more languages to keep (or type any ISO 639-1 code). Empty = all languages.", "items": { "type": "string", "enum": [ "en", "fr", "de", "es", "it", "nl", "pt", "pl", "sv", "da", "no", "fi", "cs", "ro", "hu", "el", "ru", "tr", "ar", "ja", "zh", "ko", "uk", "bg", "sk", "hr", "sl", "et", "lv", "lt", "he", "id", "ms", "th", "vi", "hi", "bn", "ta", "fa", "ur", "sr", "bs", "sq", "mk", "ka", "hy", "az", "kk", "is", "ga", "cy", "ca", "gl", "eu", "af", "sw", "tl" ], "enumTitles": [ "English", "French", "German", "Spanish", "Italian", "Dutch", "Portuguese", "Polish", "Swedish", "Danish", "Norwegian", "Finnish", "Czech", "Romanian", "Hungarian", "Greek", "Russian", "Turkish", "Arabic", "Japanese", "Chinese", "Korean", "Ukrainian", "Bulgarian", "Slovak", "Croatian", "Slovenian", "Estonian", "Latvian", "Lithuanian", "Hebrew", "Indonesian", "Malay", "Thai", "Vietnamese", "Hindi", "Bengali", "Tamil", "Persian", "Urdu", "Serbian", "Bosnian", "Albanian", "Macedonian", "Georgian", "Armenian", "Azerbaijani", "Kazakh", "Icelandic", "Irish", "Welsh", "Catalan", "Galician", "Basque", "Afrikaans", "Swahili", "Filipino" ] } }, "date": { "title": "Period", "enum": [ "", "last30days", "last3months", "last6months", "last12months" ], "type": "string", "description": "Rolling date window. For an exact cutoff use 'Published after' below — the two combine.", "default": "" }, "start_date": { "title": "Published after", "type": "string", "description": "Only reviews published on or after this date (YYYY-MM-DD). With the default 'Most recent' sort the run stops as soon as it reaches older reviews." }, "end_date": { "title": "Published before", "type": "string", "description": "Only reviews published on or before this date (YYYY-MM-DD)." }, "search": { "title": "Keywords (exact)", "type": "string", "description": "Only reviews containing this exact text (e.g. \"refund\", \"delivery\")." }, "topics": { "title": "Topics (themes)", "type": "array", "description": "Only reviews about these themes — a broader, semantic match than Keywords (e.g. \"refund\", \"customer service\", \"delivery\").", "items": { "type": "string" } }, "countries": { "title": "Reviewer countries", "type": "array", "description": "Pick one or more reviewer countries to keep (or type any ISO 3166-1 alpha-2 code). Empty = all countries.", "items": { "type": "string", "enum": [ "GB", "US", "FR", "DE", "ES", "IT", "NL", "BE", "PT", "IE", "DK", "SE", "NO", "FI", "PL", "CZ", "AT", "CH", "AU", "CA", "NZ", "IN", "JP", "BR", "MX", "AE", "SG", "ZA", "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AZ", "BS", "BH", "BD", "BB", "BY", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "IO", "VG", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "HR", "CU", "CW", "CY", "CI", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "GF", "PF", "TF", "GA", "GM", "GE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "HN", "HK", "HU", "IS", "ID", "IR", "IQ", "IM", "IL", "JM", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NC", "NI", "NE", "NG", "NU", "NF", "KP", "MK", "MP", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PR", "QA", "RO", "RU", "RW", "RE", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "SA", "SN", "RS", "SC", "SL", "SX", "SK", "SI", "SB", "SO", "GS", "KR", "SS", "LK", "SD", "SR", "SJ", "SY", "ST", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "VI", "UG", "UA", "UM", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW", "AX" ], "enumTitles": [ "United Kingdom", "United States", "France", "Germany", "Spain", "Italy", "Netherlands", "Belgium", "Portugal", "Ireland", "Denmark", "Sweden", "Norway", "Finland", "Poland", "Czechia", "Austria", "Switzerland", "Australia", "Canada", "New Zealand", "India", "Japan", "Brazil", "Mexico", "United Arab Emirates", "Singapore", "South Africa", "Afghanistan", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua and Barbuda", "Argentina", "Armenia", "Aruba", "Azerbaijan", "Bahamas", "Bahrain", "Bangladesh", "Barbados", "Belarus", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bonaire, Sint Eustatius and Saba", "Bosnia and Herzegovina", "Botswana", "Bouvet Island", "British Indian Ocean Territory", "British Virgin Islands", "Brunei", "Bulgaria", "Burkina Faso", "Burundi", "Cabo Verde", "Cambodia", "Cameroon", "Cayman Islands", "Central African Republic", "Chad", "Chile", "China", "Christmas Island", "Cocos (Keeling) Islands", "Colombia", "Comoros", "Congo", "Congo (DRC)", "Cook Islands", "Costa Rica", "Croatia", "Cuba", "Curaçao", "Cyprus", "Côte d'Ivoire", "Djibouti", "Dominica", "Dominican Republic", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Eswatini", "Ethiopia", "Falkland Islands", "Faroe Islands", "Fiji", "French Guiana", "French Polynesia", "French Southern Territories", "Gabon", "Gambia", "Georgia", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guinea", "Guinea-Bissau", "Guyana", "Haiti", "Heard Island and McDonald Islands", "Honduras", "Hong Kong", "Hungary", "Iceland", "Indonesia", "Iran", "Iraq", "Isle of Man", "Israel", "Jamaica", "Jersey", "Jordan", "Kazakhstan", "Kenya", "Kiribati", "Kuwait", "Kyrgyzstan", "Laos", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macao", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Micronesia", "Moldova", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Myanmar", "Namibia", "Nauru", "Nepal", "New Caledonia", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "North Korea", "North Macedonia", "Northern Mariana Islands", "Oman", "Pakistan", "Palau", "Palestine", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn", "Puerto Rico", "Qatar", "Romania", "Russia", "Rwanda", "Réunion", "Saint Barthélemy", "Saint Helena", "Saint Kitts and Nevis", "Saint Lucia", "Saint Martin", "Saint Pierre and Miquelon", "Saint Vincent and the Grenadines", "Samoa", "San Marino", "Saudi Arabia", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Sint Maarten", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Georgia and the South Sandwich Islands", "South Korea", "South Sudan", "Sri Lanka", "Sudan", "Suriname", "Svalbard and Jan Mayen", "Syria", "São Tomé and Príncipe", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "Timor-Leste", "Togo", "Tokelau", "Tonga", "Trinidad and Tobago", "Tunisia", "Turkey", "Turkmenistan", "Turks and Caicos Islands", "Tuvalu", "U.S. Virgin Islands", "Uganda", "Ukraine", "United States Minor Outlying Islands", "Uruguay", "Uzbekistan", "Vanuatu", "Vatican City", "Venezuela", "Vietnam", "Wallis and Futuna", "Western Sahara", "Yemen", "Zambia", "Zimbabwe", "Åland Islands" ] } }, "verified": { "title": "Verified reviews only", "type": "boolean", "description": "Only reviews with a verified order / invitation.", "default": false }, "replies_only": { "title": "With company reply only", "type": "boolean", "description": "Only reviews the company has replied to.", "default": false }, "sort": { "title": "Sort by", "enum": [ "recency", "relevance" ], "type": "string", "description": "Review ordering.", "default": "recency" }, "expand_regional_domains": { "title": "Expand regional domains", "type": "boolean", "description": "After resolving a company, also scrape every regional sibling on Trustpilot (e.g. amazon → amazon.com, amazon.co.uk, amazon.de…). The per-company limit applies to each sibling.", "default": false }, "strict_name_match": { "title": "Strict name matching", "type": "boolean", "description": "Reject search hits whose business name doesn't clearly match your query (keeps adjacent-but-wrong brands out). Off = accept Trustpilot's top suggestion.", "default": false }, "max_reviews_per_company": { "title": "Max reviews per company", "minimum": 0, "type": "integer", "description": "How many reviews to collect per company / reviewer (0 = as many as available). With regional expansion this applies to each domain.", "default": 100 }, "include_company_info": { "title": "Include company profile", "type": "boolean", "description": "Attach the full company profile to every review: TrustScore, rating distribution, category, review velocity, reply behaviour, and contact details (email, phone, address).", "default": true }, "flatten_company_data": { "title": "Flat company columns (CSV-friendly)", "type": "boolean", "description": "Also add flat top-level columns (company_name, company_domain, company_trust_score…) next to the nested company object — ideal for CSV / Excel exports.", "default": false }, "emit_input_status": { "title": "Report empty inputs", "type": "boolean", "description": "Add an input_status report to the run's OUTPUT record listing which inputs returned no reviews and why (not found, empty, filtered out).", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential proxies are recommended for reliable runs." } } }, "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 } } } } } } } } } }