API reference

Trustpilot Reviews API

Reviews of a company on Trustpilot with rating, title, text, date, reviewer location and any company reply. Queued task.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/trustpilot/reviewslive · proven5 credits

Try in Playground

Parameters

Query parameters

Useful optional inputs

sort — Choose the documented source ordering before paging through results.
Ordering keeps the normal endpoint price and does not guarantee exhaustive results.
limit — Bound the returned rows to what your task needs.
A smaller limit does not necessarily reduce source calls or price; inspect the quote.
dry_run — Read a free estimate before fetching sources or scheduling paid work.
Zero credits; cache status and availability are snapshots rather than guarantees.

Name	Required	Description	Example
`domain`	yes	The company's domain	`monzo.com`
`sort`	no	recency or relevance Accepted values: recency, relevance. Case, spaces, hyphens and underscores are interchangeable.	`recency`
`limit`	no	Reviews, up to 100	`20`
`dry_run`	no	Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable.	`1`
`judgments`	no	Add bounded AI labels to eligible returned records (default on). off preserves the original data shape. Unclassified records remain present; labels depend on evidence, time, capacity and the existing request budget. No label surcharge. Accepted values: on, off. Case, spaces, hyphens and underscores are interchangeable.	`on`
`label`	no	Set none to disable labels; default enables the endpoint’s label set. Equivalent to judgments=off. Accepted values: default, none. Case, spaces, hyphens and underscores are interchangeable.	`none`
`label_evidence`	no	Include exact supporting sentences and zero-based sentence indexes when a label has validated evidence. No extra charge or change to decisions. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable.	`1`
`exclude`	no	Optionally remove confidently labelled engagement bait. Uncertain and unclassified records stay; removed IDs and an owner-bound recall reference are returned. Accepted values: engagement_bait. Case, spaces, hyphens and underscores are interchangeable.	`engagement_bait`
`fit`	no	Use goal to replace confidently irrelevant records with recall stubs. Keeps first, last, relevant and uncertain records; preserves order. Full evidence is stored for 24 hours when available. Accepted values: goal. Case, spaces, hyphens and underscores are interchangeable.	`goal`
`goal`	no	Required with fit=goal: describe the task in at most 600 characters. Supplied text is task context, never permission to act on posts.	`Find concrete product complaints`
`tokens`	no	Optional soft response target for fit=goal, 256–32000. Safety and evidence retention take priority, so the returned result may exceed it.	`4000`

Examples

Make the request

curl

curl "https://www.monocrawl.com/v1/trustpilot/reviews?domain=monzo.com" \
  -H "x-api-key: mn_your_key_here"

TypeScript

typescript

const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
  "https://www.monocrawl.com/v1/trustpilot/reviews?domain=monzo.com",
  { headers: { "x-api-key": key } },
);
const body = await res.json();

if (!body.success) {
  // one error shape for every endpoint — see /docs/errors
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data, "credits left:", body.credits_remaining);

Python

python

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/trustpilot/reviews?domain=monzo.com",
    headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
    timeout=60,
)
body = res.json()

if not body["success"]:
    # one error shape for every endpoint — see /docs/errors
    raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")

print(body["data"], "credits left:", body["credits_remaining"])

Response

Response fields and example

This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.

200 · application/json

{
  "success": true,
  "platform": "trustpilot",
  "endpoint": "/v1/trustpilot/reviews",
  "data": {
    "items": [
      {
        "id": "68a1b2c3d4e5f67890123456",
        "url": "https://www.trustpilot.com/reviews/68a1b2c3d4e5f67890123456",
        "text": "Illustrative review."
      }
    ],
    "cursor": null,
    "has_more": null
  },
  "credits_used": 5,
  "credits_remaining": 99,
  "request_id": "req_…",
  "cached": false
}

The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.

Schema basis: reviewed response shaper. See schema coverage and validation limits.

Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.

Field inside data	Type	Meaning
`items`	`array`	Records in this response page.
`items[].id`	`string \| null`	Source ID or validated ID extracted from the canonical review URL.
`items[].url`	`string \| null`	Original source URL when supplied.
`items[].title`	`string \| null`	Review title.
`items[].text`	`string \| null`	Review text.
`items[].rating`	`object \| null`	Nested response fields; optional unless explicitly documented.
`items[].rating.value`	`number \| null`	Source star-rating value.
`items[].rating.votes`	`number \| null`	Ratings reported by the source; null or absent is unknown, not zero.
`items[].rating.max`	`number \| null`	Maximum of the rating scale, normally 5.
`items[].posted_at`	`string \| null`	Source review timestamp, publication date or relative age text; not the API retrieval time.
`count`	`number \| null`	Returned row count when supplied; not the full source total.
`cursor`	`string \| null`	Opaque next-page token. A missing token does not prove full history was retrieved.
`has_more`	`boolean \| null`	Source continuation indicator; null means unknown.
`_warnings`	`array`	Collection limitations or component warnings. Read before interpreting coverage.

Slow requests return HTTP 202 with task_id and status_url. Poll that owner-scoped URL at zero credits. The original task is charged once; terminal failures are refunded. Do not submit a new request to poll.

Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference

Trustpilot Reviews API

Query parameters

Make the request

Response fields and example

Useful next calls

First call in under a minute