Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chukhraiartur/seo-position-tracker-ruby

A simple Ruby CLI and in-code SEO position tracking tool for Google and 5 other search engines.
https://github.com/chukhraiartur/seo-position-tracker-ruby

bing duckduckgo google naver ranking ruby ruby-gem ruby-lib seo serpapi webscraping yahoo

Last synced: 21 days ago
JSON representation

A simple Ruby CLI and in-code SEO position tracking tool for Google and 5 other search engines.

Host: GitHub
URL: https://github.com/chukhraiartur/seo-position-tracker-ruby
Owner: chukhraiartur
License: bsd-3-clause
Created: 2023-04-28T11:24:07.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2023-07-14T02:28:07.000Z (over 1 year ago)
Last Synced: 2024-12-15T16:17:15.533Z (about 2 months ago)
Topics: bing, duckduckgo, google, naver, ranking, ruby, ruby-gem, ruby-lib, seo, serpapi, webscraping, yahoo
Language: Ruby
Homepage:
Size: 20.5 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Special thanks to:

API to get search engine results with ease.

Ruby SEO Position Tracker

A simple Ruby CLI and in-code SEO position tracking tool for Google and 5 other search engines.

This tool uses [SerpApi](https://serpapi.com/) as a tool to parse data from search engines.

You can use provided API key that will be available after installation, however, it's purely for testing purposes to see if the tool fits your needs. If you'll be using it for your own purpose (personal or commercial), you have to use [your own SerpApi key](https://serpapi.com/manage-api-key).

## 🔎 Current search engines support

- Google Search - first 100 organic results.
- Bing Search - first 50 organic results.
- DuckDuckGo Search - up to 30 organic results.
- Yahoo! Search - first 10 organic results.
- Yandex Search - up to 15 organic results.
- Naver Search - first 15 organic results.

## ⚙️Installation

```bash
$ gem install seo-position-tracker-ruby
```

## 🤹‍♂️Usage

```bash
$ seo -h
```

Available arugments

```lang-none
Usage: seo [options]
-q, --query QUERY Search query. Default "coffee".
-k, --target-keywords KEYWORDS Target keywords to track. Default "coffee".
-w, --target-websites WEBSITES Target websites to track. Default "starbucks.com".
-e, --search-engine ENGINES Choosing a search engine to track: "google", "bing", "duckduckgo", "yahoo", "yandex", "naver". You can select multiple search engines by separating them with a comma: google,bing. All search engines are selected by default.
-a, --api-key API_KEY Your SerpApi API key: https://serpapi.com/manage-api-key. Default is a test API key to test CLI.
-l, --language LANGUAGE Language of the search. Supported only for "google", "yahoo" and "yandex" engines. Default is nil.
-c, --country COUNTRY Country of the search. Supported only for "google", "bing" and "yahoo" engines. Default is nil.
-p, --location LOCATION Location of the search. Supported only for "google", "bing", "duckduckgo" and "yandex" engines. Default is nil.
-d, --domain DOMAIN Search engine domain to use. Supported only for "google", "yahoo" and "yandex" engines. Default is nil.
-s, --save-to SAVE Saves the results in the current directory in the selected format (CSV, JSON, TXT). Default CSV.
```

## 🤹‍♂️Examples

#### Extracting positions from all search engines for a given query with a target website and a target keyword:

```bash
$ seo --api-key= \
-q "minecraft" \
-k official \
-w minecraft.net
```

```json
[
{
"engine": "google",
"position": 1,
"title": "Welcome to the Minecraft Official Site | Minecraft",
"link": "https://www.minecraft.net/en-us"
},
{
"engine": "bing",
"position": 1,
"title": "Welcome to the Minecraft Official Site | Minecraft",
"link": "https://www.minecraft.net/"
},
{
"engine": "duckduckgo",
"position": 1,
"title": "Welcome to the Minecraft Official Site | Minecraft",
"link": "https://www.minecraft.net/"
},
{
"engine": "yahoo",
"position": 1,
"title": "Welcome to the Minecraft Official Site | Minecraft",
"link": "https://www.minecraft.net/"
},
{
"engine": "yandex",
"position": 1,
"title": "Welcome to the Minecraft Official Site | Minecraft",
"link": "https://www.minecraft.net/"
}
]
```

#### Extracting positions from 3 search engines with default arguments and saving to CSV:

```bash
$ seo --api-key= \
-e google,bing,duckduckgo \
-s CSV
```

```json
[
{
"engine": "google",
"position": 7,
"title": "Starbucks Coffee Company",
"link": "https://www.starbucks.com/"
},
{
"engine": "bing",
"position": 4,
"title": "Starbucks Coffee Company",
"link": "https://www.starbucks.com/"
},
{
"engine": "bing",
"position": 13,
"title": "The Best Coffee from Starbucks Coffee: Starbucks Coffee Company",
"link": "https://www.starbucks.com/coffee/"
},
{
"engine": "duckduckgo",
"position": 2,
"title": "Starbucks Coffee Company",
"link": "https://www.starbucks.com/"
},
{
"engine": "duckduckgo",
"position": 11,
"title": "The Best Coffee from Starbucks Coffee: Starbucks Coffee Company",
"link": "https://www.starbucks.com/coffee/"
}
]
```

#### Extracting positions from one engine with all arguments for it:

```bash
$ seo --api-key= \
-q serpapi \
-k "Google Search API" \
-w "https://serpapi.com/" \
-e google \
-l de \
-c de \
--location Germany \
-d google.de \
-s txt
```

```json
[
{
"engine": "google",
"position": 1,
"title": "SerpApi: Google Search API",
"link": "https://serpapi.com/"
}
]
```

#### Extracting positions from all search engines manually (without CLI):

```ruby
require "seo-position-tracker-ruby"

tracker = SeoPositionTracker::Scraper.new(
query='coffee',
api_key='',
keywords=['coffee', 'starbucks'],
websites=['starbucks.com', 'wikipedia.org']
)

position_data = []

google_results = tracker.scrape_google(lang='en', country='us', location='United States', domain='google.com')
position_data.concat(google_results)

bing_results = tracker.scrape_bing(country='us', location='United States')
position_data.concat(bing_results)

duckduckgo_results = tracker.scrape_duckduckgo(location='us-en')
position_data.concat(duckduckgo_results)

yahoo_results = tracker.scrape_yahoo(lang='lang_en', country='us', domain='uk')
position_data.concat(yahoo_results)

yandex_results = tracker.scrape_yandex(lang='en', domain='yandex.com')
position_data.concat(yandex_results)

naver_results = tracker.scrape_naver()
position_data.concat(naver_results)

tracker.save_to_csv(position_data)
tracker.save_to_json(position_data)
tracker.save_to_txt(position_data)

tracker.print(position_data)
```

## 💡Issues or suggestions

Visit [issues](https://github.com/chukhraiartur/seo-position-tracker-ruby/issues) page.

## 📜 Licence

Ruby SEO Position Tracker is released under the [BSD-3-Clause Licence](https://github.com/chukhraiartur/seo-position-tracker-ruby/blob/main/LICENSE).