Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions examples/Company Insights.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Company Insights With Ruby

Finds company details such as revenue, size, founding year, public status, etc. [Outscraper API](https://app.outscraper.cloud/api-docs#tag/Other-Services/paths/~1company-insights/get).

## Installation

Install the gem and add to the application's Gemfile by executing:
```bash
bundle add outscraper
```

If bundler is not being used to manage dependencies, install the gem by executing:
```bash
gem install outscraper
```

[Link to the Ruby package page](https://rubygems.org/gems/outscraper)

## Initialization
```ruby
require 'Outscraper'

client = Outscraper::Client.new('SECRET_API_KEY')
```
[Link to the profile page to create the API key](https://app.outscraper.com/profile)

## Usage

```ruby
# Get information about the companies:
results = client.company_insights('outscraper.com')
```
32 changes: 32 additions & 0 deletions examples/Company Website Finder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Company Website Finder With Ruby

Finds company websites based on business names.[Outscraper API](https://app.outscraper.cloud/api-docs#tag/Domain-Related/paths/~1company-website-finder/get).

## Installation

Install the gem and add to the application's Gemfile by executing:
```bash
bundle add outscraper
```

If bundler is not being used to manage dependencies, install the gem by executing:
```bash
gem install outscraper
```

[Link to the Ruby package page](https://rubygems.org/gems/outscraper)

## Initialization
```ruby
require 'Outscraper'

client = Outscraper::Client.new('SECRET_API_KEY')
```
[Link to the profile page to create the API key](https://app.outscraper.com/profile)

## Usage

```ruby
# Get information about business:
results = client.company_website_finder('Apple Inc')
```
32 changes: 32 additions & 0 deletions examples/Email Addresses Finder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Email Addresses Finder With Ruby

Allows to validate email addresses. Checks if emails are deliverable. [Outscraper API](https://app.outscraper.cloud/api-docs#tag/Email-Related/paths/~1email-validator/get).

## Installation

Install the gem and add to the application's Gemfile by executing:
```bash
bundle add outscraper
```

If bundler is not being used to manage dependencies, install the gem by executing:
```bash
gem install outscraper
```

[Link to the Ruby package page](https://rubygems.org/gems/outscraper)

## Initialization
```ruby
require 'Outscraper'

client = Outscraper::Client.new('SECRET_API_KEY')
```
[Link to the profile page to create the API key](https://app.outscraper.com/profile)

## Usage

```ruby
# Validate email addresses:
results = client.validate_emails('support@outscraper.com')
```
33 changes: 33 additions & 0 deletions examples/Google Maps Photos Scraper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Google Maps Photos Scraper With Ruby

Returns Google Maps photos from places when using search queries (e.g., restaurants, Manhattan, NY, USA) or from a single place when using IDs or names (e.g., NoMad Restaurant, NY, USA, 0x886916e8bc273979:0x5141fcb11460b226, ChIJu7bMNFV-54gR-lrHScvPRX4).
In case no photos were found by your search criteria, your search request will consume the usage of one photo.[Outscraper API](https://app.outscraper.cloud/api-docs#tag/Google/paths/~1maps~1photos-v3/get).

## Installation

Install the gem and add to the application's Gemfile by executing:
```bash
bundle add outscraper
```

If bundler is not being used to manage dependencies, install the gem by executing:
```bash
gem install outscraper
```

[Link to the Ruby package page](https://rubygems.org/gems/outscraper)

## Initialization
```ruby
require 'Outscraper'

client = Outscraper::Client.new('SECRET_API_KEY')
```
[Link to the profile page to create the API key](https://app.outscraper.com/profile)

## Usage

```ruby
# Get information about the places photos:
results = client.google_maps_photos('The NoMad Restaurant, NY, USA')
```
32 changes: 32 additions & 0 deletions examples/SimilarWeb Scraper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# SimilarWeb Scraper With Ruby

Returns website analytics data including traffic, rankings, audience insights, and competitive intelligence from SimilarWeb [Outscraper API](https://app.outscraper.cloud/api-docs#tag/Domain-Related/paths/~1similarweb/get).

## Installation

Install the gem and add to the application's Gemfile by executing:
```bash
bundle add outscraper
```

If bundler is not being used to manage dependencies, install the gem by executing:
```bash
gem install outscraper
```

[Link to the Ruby package page](https://rubygems.org/gems/outscraper)

## Initialization
```ruby
require 'Outscraper'

client = Outscraper::Client.new('SECRET_API_KEY')
```
[Link to the profile page to create the API key](https://app.outscraper.com/profile)

## Usage

```ruby
# Get data from Similarweb businesses:
results = client.similarweb('apple.com')
```
33 changes: 33 additions & 0 deletions examples/Tripadvisor Reviews Scraper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Tripadvisor Reviews Scraper With Ruby

Returns reviews from Tripadvisor businesses.
In case no reviews were found by your search criteria, your search request will consume the usage of one review. [Outscraper API](https://app.outscraper.cloud/api-docs#tag/Reviews-and-Comments/paths/~1tripadvisor-reviews/get).

## Installation

Install the gem and add to the application's Gemfile by executing:
```bash
bundle add outscraper
```

If bundler is not being used to manage dependencies, install the gem by executing:
```bash
gem install outscraper
```

[Link to the Ruby package page](https://rubygems.org/gems/outscraper)

## Initialization
```ruby
require 'Outscraper'

client = Outscraper::Client.new('SECRET_API_KEY')
```
[Link to the profile page to create the API key](https://app.outscraper.com/profile)

## Usage

```ruby
# Get information about business:
results = client.tripadvisor_reviews('https://www.tripadvisor.com Restaurant_Review-g187147-d12947099-Reviews-Mayfair_Garden-Paris_Ile_de_France.html')
```
32 changes: 32 additions & 0 deletions examples/Trustpilot Reviews Scraper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Trustpilot Reviews Scraper With Ruby

Returns reviews from Trustpilot businesses. In case no reviews were found by your search criteria, your search request will consume the usage of one review.[Outscraper API](https://app.outscraper.cloud/api-docs#tag/Reviews-and-Comments/paths/~1trustpilot~1reviews/get).

## Installation

Install the gem and add to the application's Gemfile by executing:
```bash
bundle add outscraper
```

If bundler is not being used to manage dependencies, install the gem by executing:
```bash
gem install outscraper
```

[Link to the Ruby package page](https://rubygems.org/gems/outscraper)

## Initialization
```ruby
require 'Outscraper'

client = Outscraper::Client.new('SECRET_API_KEY')
```
[Link to the profile page to create the API key](https://app.outscraper.com/profile)

## Usage

```ruby
# Get information about the reviews from Trustpilot:
results = client.trustpilot_reviews('https://www.trustpilot.com/review/outscraper.com')
```
32 changes: 32 additions & 0 deletions examples/Trustpilot Scraper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Trustpilot Scraper With Ruby

Returns data from Trustpilot businesses. [Outscraper API](https://app.outscraper.cloud/api-docs#tag/Businesses-and-POI/paths/~1trustpilot/get).

## Installation

Install the gem and add to the application's Gemfile by executing:
```bash
bundle add outscraper
```

If bundler is not being used to manage dependencies, install the gem by executing:
```bash
gem install outscraper
```

[Link to the Ruby package page](https://rubygems.org/gems/outscraper)

## Initialization
```ruby
require 'Outscraper'

client = Outscraper::Client.new('SECRET_API_KEY')
```
[Link to the profile page to create the API key](https://app.outscraper.com/profile)

## Usage

```ruby
# Search data from Trustpilot businesses:
results = client.trustpilot('outscraper.com')
```
33 changes: 33 additions & 0 deletions examples/Trustpilot Search Scraper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Trustpilot Search Scraper With Ruby

Returns search results from Trustpilot. [Outscraper API](https://app.outscraper.cloud/api-docs#tag/Trustpilot/paths/~1trustpilot~1search/get).


## Installation

Install the gem and add to the application's Gemfile by executing:
```bash
bundle add outscraper
```

If bundler is not being used to manage dependencies, install the gem by executing:
```bash
gem install outscraper
```

[Link to the Ruby package page](https://rubygems.org/gems/outscraper)

## Initialization
```ruby
require 'Outscraper'

client = Outscraper::Client.new('SECRET_API_KEY')
```
[Link to the profile page to create the API key](https://app.outscraper.com/profile)

## Usage

```ruby
# Get information about the search results from Trustpilot:
results = client.trustpilot_search('real estate')
```
32 changes: 32 additions & 0 deletions examples/Yellow Pages Search Scraper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Emails And Contacts Scraper With Ruby

Allows finding email addresses, social links, and phones from domains via [Outscraper API](https://app.outscraper.com/api-docs#tag/Emails-and-Contacts).

## Installation

Install the gem and add to the application's Gemfile by executing:
```bash
bundle add outscraper
```

If bundler is not being used to manage dependencies, install the gem by executing:
```bash
gem install outscraper
```

[Link to the Ruby package page](https://rubygems.org/gems/outscraper)

## Initialization
```ruby
require 'Outscraper'

client = Outscraper::Client.new('SECRET_API_KEY')
```
[Link to the profile page to create the API key](https://app.outscraper.com/profile)

## Usage

```ruby
# Search results from Yellow Pages:
results = client.yellowpages_search('restaurants')
```
32 changes: 32 additions & 0 deletions examples/Youtube Comments Scraper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Youtube Comments Scraper With Ruby

Returns comments from YouTube videos.[Outscraper API](https://app.outscraper.cloud/api-docs#tag/Reviews-and-Comments/paths/~1youtube-comments/get).

## Installation

Install the gem and add to the application's Gemfile by executing:
```bash
bundle add outscraper
```

If bundler is not being used to manage dependencies, install the gem by executing:
```bash
gem install outscraper
```

[Link to the Ruby package page](https://rubygems.org/gems/outscraper)

## Initialization
```ruby
require 'Outscraper'

client = Outscraper::Client.new('SECRET_API_KEY')
```
[Link to the profile page to create the API key](https://app.outscraper.com/profile)

## Usage

```ruby
# Get information about the comments from YouTube videos:
results = client.youtube_comments('https://www.youtube.com/watch?v=ph5pHgklaZ0')
```
15 changes: 15 additions & 0 deletions lib/outscraper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -337,5 +337,20 @@ def company_website_finder(query, fields: '', async_request: false)
async: async_request
}).parsed_response['data']
end

def yellowpages_search(query, location: 'New York, NY', limit: 100, region: nil, enrichment: [], fields: '', async_request: false, ui: nil, webhook: nil)
enrichment_array = enrichment.is_a?(Array) ? enrichment : [enrichment]
response = self.class.get('/yellowpages-search', query: {
query: query.is_a?(Array) ? query : [query],
location: location,
limit: limit,
region: region,
enrichment: enrichment_array,
fields: fields,
async: async_request,
ui: ui,
webhook: webhook
}).parsed_response['data']
end
end
end
2 changes: 1 addition & 1 deletion lib/outscraper/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module Outscraper
VERSION = "0.3.1"
VERSION = "0.3.2"
end