Outscraper

https://outscraper.com/documentation/
Admin
Outscraper is a web scraping API platform that extracts data from various sources including Google,...
Tokens:171,339
Snippets:481
Trust Score:9.8
Update:10 months ago
Show doc for...
Tokens:
Raw
### Booking Reviews API Request Example (cURL)

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

Demonstrates how to make a GET request to the booking reviews API using cURL. It specifies the query URL, a limit for the number of results, and sets the asynchronous option to false. The request includes an API key for authentication.

```cURL
curl -X GET "https://api.outscraper.cloud/booking-reviews?query=https://www.booking.com/hotel/pl/aparthotel.fr.html&limit=3&async=false" -H  "X-API-KEY: NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ"
```

--------------------------------

### Fetch Emails & Contacts using Python

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

Provides a Python example for using the Outscraper API to find emails and contacts. It requires the 'outscraper' library to be installed and an API key for authentication. The code sends a request for 'outscraper.com'.

```Python
from outscraper import ApiClient

api_client = ApiClient(api_key='NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ')
results = api_client.contacts_and_leads(['outscraper.com'])
```

--------------------------------

### Retrieve Emails and Contacts using Ruby

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

This Ruby example demonstrates how to interact with the Outscraper API to get emails and contact details for a website. You need to install the 'Outscraper' gem and provide your API key.

```Ruby
require 'Outscraper'

client = Outscraper::Client.new('SECRET_API_KEY')
results = client.emails_and_contacts('outscraper.com')
```

--------------------------------

### Get App Reviews API cURL Example

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

This snippet demonstrates how to fetch reviews from GetApp using the Outscraper API via cURL. It specifies the API endpoint, the target GetApp URL, and includes an API key for authentication. The 'async' parameter indicates an asynchronous request.

```cURL (async)
curl -X GET "https://api.outscraper.cloud/getapp-reviews?query=https%3A%2F%2Fwww.getapp.com%2Fcustomer-management-software%2Fa%2Fsalesforce%2Freviews%2F&limit=3" -H  "X-API-KEY: NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ"
```

--------------------------------

### Google Flights Search API cURL Examples

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

Demonstrates how to use the Outscraper API to search for flight information using cURL. Includes examples for both synchronous and asynchronous requests, specifying query parameters like origin, destination, and dates. Requires an X-API-KEY for authentication.

```cURL
curl -X GET "https://api.outscraper.cloud/google-search-flights?query=[['EWR','JFK']]&departure_date=1756069200&return_date=1757451600&async=false" -H  "X-API-KEY: NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ"
```

```cURL (async)
curl -X GET "https://api.outscraper.cloud/google-search-flights?query=[['CMB','DXB']]" -H  "X-API-KEY: NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ"
```

--------------------------------

### Fetch Target Reviews with cURL

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

This example demonstrates how to fetch reviews for Target products using a cURL command. Similar to Walmart reviews, it allows specifying product URLs, setting a limit for reviews, and making asynchronous requests. An API key is necessary for authentication.

```cURL
curl -X GET "https://api.outscraper.cloud/target-reviews?query=https://www.target.com/p/apple-iphone-15-pro-max/-/A-89957794&limit=3" -H "X-API-KEY: YOUR_API_KEY"
```

--------------------------------

### Retrieve Request Archive - Node.js

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

This Node.js example demonstrates fetching a request archive from the Outscraper API. It shows the basic setup for making the API call, which is essential for backend JavaScript applications.

```Node.js
// Node.js example would go here
```

--------------------------------

### Company Website Finder Integration (Python, Ruby, PHP, Node.js)

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

Code examples for integrating the Outscraper Company Website Finder functionality into applications using Python, Ruby, PHP, and Node.js. These snippets demonstrate how to initialize the client with an API key and make requests to find company websites.

```Python
from outscraper import ApiClient

api_client = ApiClient(api_key='NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ')
results = api_client.company_websites_finder(['Apple Inc'])
```

```Ruby
require 'Outscraper'

client = Outscraper::Client.new('SECRET_API_KEY')
results = client.company_websites_finder('Apple Inc')
```

```PHP
$client = new OutscraperClient('NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ');
$results = $client->company_websites_finder(['Apple Inc']);
```

```Node.js
const Outscraper = require('outscraper');

let client = new Outscraper('NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ');
client.companyWebsiteFinder(['Apple Inc']).then(response => {
   console.log(response);
});
```

--------------------------------

### Fetch Walmart Reviews with cURL

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

This example shows how to retrieve reviews for Walmart products using a cURL command. It supports fetching reviews for a list of product URLs, with options for limiting the number of reviews, sorting, and making asynchronous requests. The API key is required for authentication.

```cURL
curl -X GET "https://api.outscraper.cloud/walmart-reviews?query=https://www.walmart.com/ip/Blackstone-Original-4-Burner-36-Propane-Omnivore-Griddle-with-Hard-Cover/1347629739&limit=3&async=false" -H  "X-API-KEY: NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ"
```

```cURL
curl -X GET "https://api.outscraper.cloud/walmart-reviews?query=https://www.walmart.com/ip/Blackstone-Original-4-Burner-36-Propane-Omnivore-Griddle-with-Hard-Cover/1347629739&limit=3" -H  "X-API-KEY: NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ"
```

--------------------------------

### Scrape Product Hunt Reviews with cURL

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

This example shows how to retrieve reviews from Product Hunt using cURL. It supports fetching reviews synchronously or asynchronously, requires an API key, and allows specifying the product query, review limit, and other parameters like sort order and format.

```cURL
curl -X GET "https://api.outscraper.cloud/producthunt-reviews?query=outscraper&limit=3&async=false" -H  "X-API-KEY: NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ"
```

```cURL (async)
curl -X GET "https://api.outscraper.cloud/producthunt-reviews?query=outscraper&limit=3" -H  "X-API-KEY: NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ"
```

--------------------------------

### Fetch Google Maps Reviews (Python)

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

Provides a Python code example for fetching Google Maps reviews using the Outscraper client library. It shows how to initialize the client with an API key and call the google_maps_reviews method with the desired query and review limit.

```Python
from outscraper import ApiClient

api_client = ApiClient(api_key='NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ')
results = api_client.google_maps_reviews('The NoMad Restaurant, NY, USA', reviews_limit=3)
```

--------------------------------

### GET /indeed-search

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

Retrieves search results from Indeed. This endpoint can be used to get job listings based on a provided URL.

```APIDOC
## GET /indeed-search

### Description
Retrieves search results from Indeed. This endpoint can be used to get job listings based on a provided URL.

### Method
GET

### Endpoint
/indeed-search

### Parameters
#### Query Parameters
- **query** (string) - Required - The URL of the Indeed search results page.
- **limit** (integer) - Optional - The maximum number of results to return.
- **async** (boolean) - Optional - If true, the request will be processed asynchronously.

### Request Example
```json
{
  "example": "curl -X GET \"https://api.outscraper.cloud/indeed-search?query=https%3A%2F%2Fwww.indeed.com%2Fjobs%3Fq%3D%26l%3DFremont%2BCanyon%252C%2BCA&limit=3&async=false\" -H  \"X-API-KEY: YOUR_API_KEY\""
}
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the request if async is true.
- **status** (string) - The status of the request.
- **data** (array) - An array of job listing objects.

#### Response Example
```json
{
  "example": {
    "id": "your-request-id",
    "status": "Success",
    "data": []
  }
}
```
```

--------------------------------

### Retrieve Airbnb Reviews (cURL)

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

This code snippet demonstrates how to fetch Airbnb reviews using a cURL command. It includes parameters for the query URL, the number of results, and an asynchronous option. Authentication is handled via an 'X-API-KEY' header. Ensure you replace placeholder values with your actual API key and query.

```cURL
curl -X GET "https://api.outscraper.cloud/airbnb-reviews?query=https://www.airbnb.com/rooms/927539322986647456&limit=3&async=false" -H  "X-API-KEY: NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ"
```

```cURL (async)
curl -X GET "https://api.outscraper.cloud/airbnb-reviews?query=https://www.airbnb.com/rooms/927539322986647456&limit=3" -H  "X-API-KEY: NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ"
```

--------------------------------

### Fetch Emails & Contacts using PHP

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

A PHP code example for retrieving emails and contacts via the Outscraper API. It uses the OutscraperClient class, which requires an API key. The example queries for 'outscraper.com'.

```PHP
$client = new OutscraperClient('NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ');
$results = $client->contacts_and_leads(['outscraper.com']);
```

--------------------------------

### Fetch Glassdoor Reviews (cURL)

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

This example shows how to retrieve reviews from Glassdoor using cURL. It supports direct company links and batching multiple queries up to 250. Parameters include the company URL, result limit, and sorting options (DATE or RELEVANCE).

```cURL
curl -X GET "https://api.outscraper.cloud/glassdoor-reviews?query=https://www.glassdoor.com/Reviews/Amazon-Reviews-E6036.htm&limit=3&sort=DATE" -H "X-API-KEY: YOUR_API_KEY"
```

--------------------------------

### Fetch Google Search Shopping Results (Example)

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

This snippet shows an example JSON response structure for Google Search Shopping results. It includes product details like title, price, image, and source.

```JSON
{
  "id": "your-request-id",
  "status": "Success",
  "data": [
    [
      {
        "query": "iphone",
        "position": 1,
        "link": "https://www.google.com/shopping/product/437651240330897754?q=iphone&hl=en&gl=US&uule=w+CAIQICINdW5pdGVkIHN0YXRlcw&gs_lcp=UvHSLA7Uz640JlchZYoULTOTy09hxrjXrbg1BddDeXJ1L8hKvAxhTGpJh681VIB&prds=eto:10095595960159233791_0,pid:16627194887412580682,rsk:PC_8217023720749633348&sa=X&ved=0ahUKEwjeu_vYub74AhWjj2oFHeQACRYQ8gII4BAoAA",
        "image": "https://encrypted-tbn3.gstatic.com/shopping?q=tbn:ANd9GcT3nKfqR3-wmqMxiSP-9MWZoHC87ST6G_T7ehZ8SNPjNTx62Mt8eAc-tJgSsSn_0PvARuFrq_UY53JOLehu7DMvkwqITL3Lgb2Z3JIZ3usVp-apzrcV-SScsw&usqp=CAE",
        "title": "Apple iPhone 13 Pro Max - 128 GB - Alpine Green",
        "options": "4.69,848",
        "id": "16627194887412580682",
        "source": "Apple",
        "source_link": "https://www.google.com/url?url=https://www.apple.com/us/shop/go/product/MNCP3%3Fcppart%3DUNLOCKED%26cid%3Daos-us-seo-pla&rct=j&q=&esrc=s&sa=U&ved=0ahUKEwjeu_vYub74AhWjj2oFHeQACRYQguUECOkQ&usg=AOvVaw00X6LdGKmQSLn67LlB6LPP",
        "delivery": "Free delivery & Free 14-day returns",
        "price": "$1,099.00",
        "parsed_price": 1099
      }
    ]
  ]
}
```

--------------------------------

### Get Google Maps Directions (Java)

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

Implements the Outscraper Java client to get Google Maps directions. Requires a secret API key for authentication. Supports batch requests with multiple origin-destination query pairs.

```Java
OutscraperClient client = new OutscraperClient("SECRET_API_KEY");
JSONArray results = client.googleMapsDirections(new HashMap<String, Object>() {{
    put("query", "29.696596, 76.994928    30.7159662444353, 76.8053887016268', 29.696596, 76.994928    30.723065, 76.770169");
}});
```

--------------------------------

### Retrieve GetApp Reviews (cURL)

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

This code snippet shows how to retrieve reviews from GetApp using a cURL request. It specifies the target GetApp URL, the desired limit of reviews, and an option for asynchronous processing. The API key must be provided in the 'X-API-KEY' header. Remember to replace the example URL and API key with your specific details.

```cURL
curl -X GET "https://api.outscraper.cloud/getapp-reviews?query=https%3A%2F%2Fwww.getapp.com%2Fcustomer-management-software%2Fa%2Fsalesforce%2Freviews%2F&limit=3&async=false" -H  "X-API-KEY: NzhkNWE2Y2Y4MDM3NDA3ZWIyYmU5MzJjYTAzOGJkZjJ8YzAyZmI1Zjc2NQ"
```

--------------------------------

### Fetch Google Shopping Reviews (cURL)

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

This snippet shows how to retrieve reviews for Google Shopping products using cURL. It demonstrates sending a single product query and mentions the capability to send batch requests with up to 250 queries for efficiency. The `async` parameter controls synchronous or asynchronous execution.

```cURL
curl -X GET "https://api.outscraper.cloud/google-shopping-reviews?query=https://www.google.com/shopping/product/7016166685587850095&async=false" -H  "X-API-KEY: YOUR_API_KEY"
```

```cURL (batch)
curl -X GET "https://api.outscraper.cloud/google-shopping-reviews?query=product1&query=product2&query=product3" -H  "X-API-KEY: YOUR_API_KEY"
```

--------------------------------

### GET /zillow-search

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

Returns listings from Zillow.

```APIDOC
## GET /zillow-search

### Description
Returns listings from Zillow.

### Method
GET

### Endpoint
/zillow-search

### Parameters
#### Query Parameters
- **query** (string) - Required - The search query for Zillow, typically a URL or location.

### Request Example
(Request example not provided in the input text.)

### Response
#### Success Response (200)
(Response details not provided in the input text.)

#### Response Example
(Response example not provided in the input text.)
```

--------------------------------

### Perform Google Search with Outscraper Ruby Gem

Source: https://outscraper.com/documentation/s/XoJ57iCF2XrbfbQ_dir=/&editing=false&openfile=true

This example demonstrates Google search using the Outscraper Ruby client. It involves requiring the Outscraper library, initializing a client with a secret API key, and then executing the google_search method.

```Ruby
require 'Outscraper'

client = Outscraper::Client.new('SECRET_API_KEY')
results = client.google_search('buy iphone 13 TX')
```
Tokens:
Raw