query |
query |
array<string> |
Yes |
Company or category to search on Trustpilot (e.g., real estate).
It supports batching by sending arrays with up to 1000 queries (e.g., query=text1&query=text2&query=text3). It allows multiple queries to be sent in one request and to save on network latency time. |
- |
- |
limit |
query |
integer |
No |
The parameter specifies the limit of items to get from one query. |
- |
default 100 |
skip |
query |
integer |
No |
The parameter specifies the number of items to skip. Used for pagination. |
- |
default 0 |
enrichment |
query |
array<string enum> |
No |
The parameter defines one or more enrichments you want to apply to the results (e.g., enrichment=enrichment1&enrichment=enrichment2&enrichment=enrichment3).
Available values:
leads_n_contacts — Leads & Contacts Enrichment: finds emails, social links, phones, and other contacts from websites;
emails_validator_service — Email Address Verifier: validates emails, checks deliverability, filters out blacklists, spam traps, and complainers, while significantly reducing your bounce rate;
company_websites_finder - Company Website Finder: finds company websites based on business names;
disposable_email_checker — Disposable Emails Checker: checks origins of email addresses (disposable, free, or corporate);
company_insights_service — Company Insights: Finds company firmographics such as revenue, size, founding year, public status, etc.;
phones_enricher_service — Phone Numbers Enricher: returns phones carrier data (name/type), validates phones, ensures message deliverability,
trustpilot_service — Trustpilot Scraper: returns data from a list of businesses,
whitepages_phones - Phone Identity Finder: returns insights about phone number owners (name, address, etc.);
ai_chain_info - Chain Info: identifies if a business is part of a chain, adding a true/false indication to your data for smarter targeting.
Using enrichments increases the time of the response. You might want to use the async=true parameter to avoid getting timeouts. |
- |
- |
fields |
query |
string |
No |
The parameter defines which fields you want to include with each item returned in the response. By default, it returns all fields. Use &fields=query,name to return only the specific ones. |
- |
- |
async |
query |
boolean |
Yes |
The parameter defines the way you want to submit your task to Outscraper. It can be set to false to open an HTTP connection and keep it open until you get your results, or true (default) to just submit your requests to Outscraper and retrieve them later (usually within 1-3 minutes) with the Request Results endpoint. Each response is available for 4 hours after a request has been completed.
A good practice is to send async requests and start checking the results after the estimated execution time. Check out this Python implementation as an example.
As most of the requests take some time to be executed the async=true option is preferred to avoid HTTP request timeouts. |
- |
default true |
ui |
query |
boolean |
No |
The parameter defines whether a task will be executed as a UI task. This is commonly used when you want to create a regular platform task with API.
Using this parameter overwrites the async parameter to true. |
- |
default false |
format |
query |
array<string enum> |
No |
The parameter defines the format of the output data. Using this parameter overwrites the ui parameter to true. |
- |
- |
webhook |
query |
string |
No |
The parameter defines the URL address (callback) to which Outscraper will create a POST request with a JSON body once a task/request is finished.
Using this parameter overwrites the webhook from integrations. |
- |
- |
