> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Trustpilot trustpilot Company API
> Scrape a Trustpilot company page. Call the Trustpilot trustpilot Company API and get JSON back in one request. 1 credit per call. Failed calls cost nothing.
Scrape a Trustpilot company page. The company or companyDomain is identified by its URL or companyDomain.
## Request
Exactly one of `companyUrl` or `companyDomain` is required. A request that sets both, or none, fails with `invalidRequest`.
```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null}
import { Stophy } from "stophy";
const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.trustpilot.company({ companyDomain: "stripe.com" });
console.log(result.data);
```
```python Python icon="python" theme={null}
from stophy import Stophy
stophy = Stophy() # reads STOPHY_API_KEY
result = stophy.trustpilot.company(company_domain="stripe.com")
print(result["data"])
```
```bash cURL icon="terminal" theme={null}
curl -X POST https://api.stophy.dev/v1/trustpilot/company \
-H "Authorization: Bearer $STOPHY_API_KEY" \
-H "content-type: application/json" \
-d '{"companyDomain":"stripe.com"}'
```
```bash CLI icon="square-terminal" theme={null}
stophy trustpilot company --companyDomain stripe.com
```
## Response
If successful, the response body contains the standard envelope. `data` contains the company's TrustScore, stars, review count and the number of reviews at each star rating.
The following example is a real response, truncated: each list shows one item and long strings are cut.
```json theme={null}
{
"success": true,
"data": {
"companyId": "50489e6800006400051ae0d6",
"companyDomain": "stripe.com",
"companyUrl": "https://www.trustpilot.com/review/stripe.com",
"name": "Stripe",
"website": "https://stripe.com",
"description": "Millions of businesses of all sizes—from startups to large enterprises—use Stripe’s software and APIs to accept…",
"trustScore": 1.6,
"stars": 1.5,
"reviews": 17537,
"ratingsOne": 9109,
"ratingsTwo": 512,
"ratingsThree": 469,
"ratingsFour": 725,
"ratingsFive": 6722,
"categories": ["Payment Service"],
"isClaimed": true,
"isClosed": false,
"email": "https://support.stripe.com/contact",
"addressStreet": "510 Townsend Street",
"addressCity": "San Francisco",
"addressPostalCode": "94103",
"addressCountry": "United States",
"negativeReviewsRepliedPercent": 100,
"averageDaysToReply": 1.91
},
"creditsUsed": 1,
"requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}
```
| Field | Type | Description |
| - | - | - |
| `reviews` | integer | The number of reviews the rating is based on. |
For every field, see the response schema on this page.
## Billing
Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.
## Pagination
This method is not paginated. A single request returns the complete result.
## Related methods
* [Trustpilot trustpilot Company Reviews](/api-reference/endpoint/trustpilot-company-reviews): Accepts `companyUrl`. Scrape a Trustpilot company's reviews.
## OpenAPI
````yaml api-reference/openapi.json POST /v1/trustpilot/company
openapi: 3.1.0
info:
title: Stophy API
version: '1'
description: >-
Every endpoint is a POST that takes its input as a JSON object body. Unknown
fields are rejected with 400.
Responses leave out empty values: null, empty strings, empty objects and
empty nested lists are not sent.
Text comes back whole. To get shorter responses, add
?maxTextLength= to the URL. Every text value longer than that is
cut and ends with …. A screenshot is never cut, and a page whose text was
cut has isTruncated set to true.
x-credits is what one call costs. Every call costs the same, whatever it
returns, unless an operation's description says it costs per 10 results, or
per second of audio. Then x-credits is the lowest price and x-credits-max
the most one call can cost. Where an operation takes limit, send it to
return fewer results and pay for fewer.
When a response has a cursor, send it back unchanged with the same input to
get the next page. When it has a page, send the next page number.
servers:
- url: https://api.stophy.dev
security:
- apiKey: []
paths:
/v1/trustpilot/company:
post:
summary: Scrape a Trustpilot company page
description: Costs 1 credit per call.
operationId: trustpilotCompany
parameters:
- $ref: '#/components/parameters/MaxTextLength'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
companyUrl:
type: string
description: >-
Link to the Trustpilot company, like
https://www.trustpilot.com/review/stripe.com. Send this or
companyDomain.
companyDomain:
type: string
description: >-
Trustpilot company domain, like stripe.com. Send this or
companyUrl.
sendOne:
- companyUrl
- companyDomain
additionalProperties: false
example:
companyDomain: stripe.com
responses:
'200':
description: The data, and the credits this call used.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
x-credits-used:
$ref: '#/components/headers/CreditsUsed'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
x-cache:
$ref: '#/components/headers/Cache'
x-cache-age:
$ref: '#/components/headers/CacheAge'
content:
application/json:
schema:
type: object
required:
- success
- data
- creditsUsed
- requestId
properties:
success:
const: true
data:
type: object
additionalProperties: false
properties:
companyId:
type: string
companyDomain:
type: string
companyUrl:
type: string
format: uri
name:
type: string
website:
type: string
format: uri
description:
type: string
trustScore:
type: number
stars:
type: number
reviews:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
ratingsOne:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
ratingsTwo:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
ratingsThree:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
ratingsFour:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
ratingsFive:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
categories:
type: array
items:
type: string
isClaimed:
type: boolean
isClosed:
type: boolean
email:
type: string
phone:
type: string
addressStreet:
type: string
addressCity:
type: string
addressPostalCode:
type: string
addressCountry:
type: string
negativeReviewsRepliedPercent:
type: number
averageDaysToReply:
type: number
required:
- companyUrl
- categories
- isClaimed
- isClosed
creditsUsed:
type: integer
requestId:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
components:
parameters:
MaxTextLength:
name: maxTextLength
in: query
required: false
description: >-
Cut every text value in the response to this many characters. A value
that was cut ends with …, and a page whose text was cut has isTruncated
set to true. A screenshot is never cut. Leave it out to get the full
text.
schema:
type: integer
minimum: 1
headers:
RequestId:
description: The request id. Quote it when you report a problem.
schema:
type: string
CreditsUsed:
description: Credits this call used.
schema:
type: integer
RateLimitLimit:
description: Requests allowed in the current window.
schema:
type: integer
RateLimitRemaining:
description: Requests left in the current window.
schema:
type: integer
RateLimitReset:
description: Unix time in seconds when the current window resets.
schema:
type: integer
Cache:
description: hit if this result came from the cache, miss if it was fetched live.
schema:
type: string
CacheAge:
description: Seconds since the returned result was written to the cache.
schema:
type: integer
RetryAfter:
description: Seconds to wait before retrying.
schema:
type: integer
responses:
Error:
description: The request failed. retryable says whether trying again can help.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
Retry-After:
$ref: '#/components/headers/RetryAfter'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
required:
- success
- error
properties:
success:
const: false
error:
type: object
required:
- code
- message
- retryable
- requestId
properties:
code:
type: string
enum:
- cliSessionCompleted
- cliSessionExists
- cliSessionNotFound
- forbidden
- insufficientCredits
- internalError
- inviteClaimed
- inviteDisabled
- inviteExpired
- inviteUsedUp
- invalidCliSession
- invalidCliVerifier
- invalidRequest
- notFound
- rateLimited
- sourceChanged
- sourceRefused
- sourceTimeout
- sourceUnavailable
- tooManyInFlight
- unauthorized
- unsupportedMediaType
message:
type: string
retryable:
type: boolean
retryAfterSeconds:
type: integer
requestId:
type: string
requiredCredits:
type: number
availableCredits:
type: number
billingUrl:
type: string
const: https://stophy.dev/billing
securitySchemes:
apiKey:
type: http
scheme: bearer
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.