{ "openapi": "3.0.1", "info": { "title": "Trustpilot Company Data & TrustScore", "description": "Trustpilot company scraper: TrustScore, star breakdown, review counts, transparency report (organic vs invited, reviews removed, reply rate) and website, email, phone, address for any company, or find companies by keyword or category. No login.", "version": "0.1", "x-build-id": "YElOJkBYMIARRogRo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/deepmine~trustpilot-company-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-deepmine-trustpilot-company-data", "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/deepmine~trustpilot-company-data/runs": { "post": { "operationId": "runs-sync-deepmine-trustpilot-company-data", "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/deepmine~trustpilot-company-data/run-sync": { "post": { "operationId": "run-sync-deepmine-trustpilot-company-data", "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": { "companies": { "title": "๐Ÿข Companies (pages, domains or names)", "type": "array", "description": "A Trustpilot page (https://www.trustpilot.com/review/apple.com, any country site), a website (amazon.com) or a name (Booking.com, best match used). One row each.", "items": { "type": "string", "pattern": "\\S" } }, "searchTerms": { "title": "๐Ÿ” Or find companies by keyword", "type": "array", "description": "Trustpilot's own business search, e.g. vpn or solar panels. One full company row per company found, the same columns as a listed company.", "items": { "type": "string", "pattern": "\\S" }, "default": [] }, "maxBusinesses": { "title": "๐Ÿ“Š Max companies per keyword or category", "minimum": 1, "maximum": 10000, "type": "integer", "description": "The most companies saved per keyword or category.", "default": 100 }, "includeTransparency": { "title": "๐Ÿงพ Add the transparency report", "type": "boolean", "description": "Adds Trustpilot's transparency report to every company, listed or found: organic vs invited reviews, reports, reviews taken offline, reply rate, monthly counts. No extra charge.", "default": true }, "categories": { "title": "๐Ÿ”Ž Categories", "type": "array", "description": "Trustpilot categories: an id (electronics_store) or its page URL. One full company row per company found.", "items": { "type": "string", "pattern": "\\S" }, "default": [] }, "country": { "title": "๐Ÿ“ Business country (categories)", "type": "string", "description": "Categories only: businesses from this country, as an ISO code, e.g. US, DE. Empty = Trustpilot's default for the category." }, "minTrustScore": { "title": "Minimum TrustScore", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keyword and category results only: companies with at least this TrustScore, e.g. 4. Empty = any score." }, "maxReviewsPerCompany": { "title": "๐Ÿ“Š Max reviews per company", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Reviews per company (0 = company data only). For reviews, use Trustpilot Reviews API.", "default": 0 }, "includeCompanyRows": { "title": "Add a company row ($)", "type": "boolean", "description": "One row per company in ๐Ÿข Companies.", "default": true }, "flatRows": { "title": "Flat rows", "type": "boolean", "description": "Every row with the same flat columns (lists as text).", "default": true }, "foundBusinessesAsCompanies": { "title": "Found businesses as companies", "type": "boolean", "description": "Companies found by keyword or category get the full company row (star breakdown, transparency report).", "default": 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 }, "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 } } } } } } } } } }