API reference
Trustpilot Company API
A company's Trustpilot profile by domain: rating, review count, categories and claimed status. Queued task.
Endpoint
/v1/trustpilot/companylive · proven7 creditsParameters
Query parameters
Useful optional inputs
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 |
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 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/trustpilot/company?domain=monzo.com" \ -H "x-api-key: mn_your_key_here"
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/company?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
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/trustpilot/company?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.
{
"success": true,
"platform": "trustpilot",
"endpoint": "/v1/trustpilot/company",
"data": {
"about": "example",
"address": "example",
"asking_for_reviews": false,
"average_days_to_reply": 0,
"categories": [
"example"
],
"category_ranks": [
{
"id": "example",
"name": "example",
"of": 0,
"rank": 0
}
],
"claimed": false,
"closed": false,
"domain": "example",
"id": "example",
"location": "example",
"logo": "example",
"name": "example",
"negative_review_count": 0,
"platform": "example",
"rating": {
"max": 0,
"value": 0,
"votes": 0
},
"rating_distribution": {},
"reply_to_negative_review_percent": 0,
"reviews_count": 0,
"trust_score": 0,
"url": "https://example.com/example",
"verified": false,
"website": "example"
},
"credits_used": 7,
"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: observed response shapes, not an exhaustive field specification. 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 |
|---|---|---|
about | string | null | Optional about supplied by this operation. Null means unknown. |
address | string | null | Optional address supplied by this operation. Null means unknown. |
asking_for_reviews | boolean | null | Optional asking for reviews supplied by this operation. Null means unknown. |
average_days_to_reply | number | null | Optional average days to reply supplied by this operation. Null means unknown. |
categories | array | null | Optional categories supplied by this operation. Null means unknown. |
category_ranks | array | null | Optional category ranks supplied by this operation. Null means unknown. |
category_ranks[].id | string | null | Source identifier. Preserve the supplied type and exact value. |
category_ranks[].name | string | null | Optional name supplied by this operation. Null means unknown. |
category_ranks[].of | number | null | Optional of supplied by this operation. Null means unknown. |
category_ranks[].rank | number | null | Optional rank supplied by this operation. Null means unknown. |
claimed | boolean | null | Optional claimed supplied by this operation. Null means unknown. |
closed | boolean | null | Optional closed supplied by this operation. Null means unknown. |
domain | string | null | Optional domain supplied by this operation. Null means unknown. |
id | string | null | Source identifier. Preserve the supplied type and exact value. |
location | string | null | Optional location supplied by this operation. Null means unknown. |
logo | string | null | Optional logo supplied by this operation. Null means unknown. |
name | string | null | Optional name supplied by this operation. Null means unknown. |
negative_review_count | number | null | Optional negative review count supplied by this operation. Null means unknown. |
platform | string | null | Optional platform supplied by this operation. Null means unknown. |
rating | object | null | Source rating; read its accompanying scale and vote count. |
rating.max | number | null | Optional max supplied by this operation. Null means unknown. |
rating.value | number | null | Optional value supplied by this operation. Null means unknown. |
rating.votes | number | null | Optional votes supplied by this operation. Null means unknown. |
rating_distribution | object | null | Optional rating distribution supplied by this operation. Null means unknown. |
reply_to_negative_review_percent | number | null | Optional reply to negative review percent supplied by this operation. Null means unknown. |
reviews_count | number | null | Optional reviews count supplied by this operation. Null means unknown. |
trust_score | number | null | Optional trust score supplied by this operation. Null means unknown. |
url | string | null | Original source URL when supplied. |
verified | boolean | null | Optional verified supplied by this operation. Null means unknown. |
website | string | null | Optional website supplied by this operation. Null means unknown. |
Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.
The example is invented and illustrates types only; zero and empty values are not claims about a real result.
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