{
  "openapi": "3.0.1",
  "info": {
    "title": "Trustpilot Reviews Scraper",
    "description": "Scrape Trustpilot reviews and company data by domain: ratings, titles, review text, reviewer, country, language, company replies, and business stats. Export JSON, CSV, Excel.",
    "version": "1.0",
    "x-build-id": "K4xg1tQ0ilYsqW0FE"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/parsebird~trustpilot-reviews-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-parsebird-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/parsebird~trustpilot-reviews-scraper/runs": {
      "post": {
        "operationId": "runs-sync-parsebird-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/parsebird~trustpilot-reviews-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-parsebird-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",
        "properties": {
          "companyWebsite": {
            "title": "Company website",
            "type": "string",
            "description": "Company domain as it appears on Trustpilot, e.g. shopwagandtail.com. For several companies, separate domains with commas (apple.com, samsung.com) and set 'What to extract' to Bulk company information."
          },
          "contentToExtract": {
            "title": "What to extract",
            "enum": [
              "companyInformationAndReviews",
              "reviews",
              "companyInformation",
              "bulkCompanyInformation"
            ],
            "type": "string",
            "description": "Choose the data to collect.",
            "default": "companyInformationAndReviews"
          },
          "sortBy": {
            "title": "Sort reviews by",
            "enum": [
              "recency",
              "relevance"
            ],
            "type": "string",
            "description": "Recency lists the newest reviews first. Relevance lists the most relevant, detailed reviews first.",
            "default": "recency"
          },
          "filterByStarRating": {
            "title": "Filter by star rating",
            "enum": [
              "",
              "1",
              "2",
              "3",
              "4",
              "5"
            ],
            "type": "string",
            "description": "Keep only reviews with the selected star rating. Only one rating can be selected per run.",
            "default": ""
          },
          "filterByDatePeriod": {
            "title": "Filter by date period",
            "enum": [
              "",
              "last30days",
              "last3months",
              "last6months",
              "last12months"
            ],
            "type": "string",
            "description": "Keep only reviews posted within the selected period, using Trustpilot's native date filters.",
            "default": ""
          },
          "filterByLanguage": {
            "title": "Filter by language",
            "type": "string",
            "description": "Two-letter language code, e.g. en, da, es. Only one language per run. Leave empty to collect all languages."
          },
          "filterByCountryOfReviewers": {
            "title": "Filter by reviewer country",
            "type": "string",
            "description": "ISO Alpha-2 country code of the reviewer, e.g. US, DK, GB. Applied to the collected reviews."
          },
          "filterByVerifiedReviews": {
            "title": "Verified reviews only",
            "type": "boolean",
            "description": "Collect only reviews that Trustpilot has verified.",
            "default": false
          },
          "startFromPageNumber": {
            "title": "Start from page number",
            "minimum": 1,
            "type": "integer",
            "description": "First review page to scrape (each page holds 20 reviews). Leave at 1 to start from the beginning.",
            "default": 1
          },
          "endAtPageNumber": {
            "title": "End at page number",
            "minimum": 0,
            "type": "integer",
            "description": "Last review page to scrape. Set to 0 to scrape to the last available page.",
            "default": 0
          },
          "includeReviewerMetadata": {
            "title": "Include reviewer metadata",
            "type": "boolean",
            "description": "Add reviewerNumberOfReviews and reviewerProfileIsVerified to each review.",
            "default": false
          },
          "includeReplyAnalysis": {
            "title": "Include reply analysis",
            "type": "boolean",
            "description": "Add companyReplyPublishedDate and companyReplyUpdatedDate to reviews that have a company response.",
            "default": false
          },
          "includeExtendedMetadata": {
            "title": "Include extended metadata",
            "type": "boolean",
            "description": "Add reviewSource, reviewVerificationSource, and reviewLikes to each review.",
            "default": false
          },
          "includeCompanyResponseMetrics": {
            "title": "Include company response metrics",
            "type": "boolean",
            "description": "Add reply metrics (replyAverageDaysToReply, replyPercentage, companyUsesAIResponses, and more) to the company information dataset.",
            "default": false
          },
          "includeReviewPhotos": {
            "title": "Include review photos",
            "type": "boolean",
            "description": "Add reviewPhotoUrls (array of photo URLs) to reviews that have attached photos.",
            "default": false
          },
          "extractExperienceDate": {
            "title": "Extract experience date",
            "type": "boolean",
            "description": "Include the reviewDateOfExperience field on each review. Turn off to omit it.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Trustpilot is protected by an anti-bot challenge. The Apify Proxy UNBLOCKER group clears it and is used by default; the actor cannot collect data without a working proxy.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "UNBLOCKER"
              ]
            }
          },
          "proxies": {
            "title": "Custom proxy URLs",
            "type": "array",
            "description": "Your own (non-Apify) proxy URLs, e.g. http://user:pass@proxy.example.com:8000. When set, these are used instead of Apify Proxy.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "apifyProxyCountry": {
            "title": "Apify proxy country",
            "type": "string",
            "description": "Force Apify proxy IPs to a specific 2-letter ISO country code, e.g. US, GB. Only applies when Apify Proxy is used."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}