Official Ruby SDK for ScrapeBadger — one API key for 30+ scraping APIs: Twitter/X, Reddit, Facebook, Instagram, TikTok, YouTube, Amazon, eBay, Walmart, Vinted, Google (18 products), Bing, Yahoo, ChatGPT, Perplexity, real estate, and any URL via the general Web Scraping API. Generated from the ScrapeBadger OpenAPI spec — always in sync with the API. ⚠️ This repository is regenerated automatically; don't send PRs here, request changes via the roadmap.

📚 API docs · 🧰 All SDKs · 🔑 Get an API key — 1,000 free credits

gem install scrapebadger

require 'scrapebadger'

ScrapeBadger.configure do |config|
  config.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'
end

twitter = ScrapeBadger::TwitterApi.new
user = twitter.twitter_get_user_by_username('elonmusk')
puts user

Every scraper is available as its own API class (TwitterApi, AmazonApi, GoogleApi, …) with one method per endpoint — the full list is in the reference below.

bundle install               # deps
gem build scrapebadger.gemspec   # package
bundle exec rspec            # tests

ScrapeBadger - the Ruby gem for the ScrapeBadger API

Unified credit-based scraping API. https://docs.scrapebadger.com

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 0.1.0
• Generator version: 7.10.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

To build the Ruby code into a gem:

gem build scrapebadger.gemspec

Then either install the gem locally:

gem install ./scrapebadger-0.1.0.gem

(for development, run gem install --dev ./scrapebadger-0.1.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'scrapebadger', '~> 0.1.0'

If the Ruby gem is hosted at a git repository: https://github.com/scrape-badger/scrapebadger-ruby, then add the following in the Gemfile:

gem 'scrapebadger', :git => 'https://github.com/scrape-badger/scrapebadger-ruby.git'

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Please follow the installation procedure and then run the following code:

# Load the gem
require 'scrapebadger'

# Setup authorization
ScrapeBadger.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['X-API-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-API-Key'] = 'Bearer'
end

api_instance = ScrapeBadger::AccountApi.new

begin
  #Get account info
  result = api_instance.account_get_account_info
  p result
rescue ScrapeBadger::ApiError => e
  puts "Exception when calling AccountApi->account_get_account_info: #{e}"
end

All URIs are relative to https://scrapebadger.com

• ScrapeBadger::AccountInfo
• ScrapeBadger::BillingLogListResponse
• ScrapeBadger::BillingLogResponse
• ScrapeBadger::FilterRuleCreate
• ScrapeBadger::FilterRuleDeliveryLogListResponse
• ScrapeBadger::FilterRuleDeliveryLogResponse
• ScrapeBadger::FilterRuleListResponse
• ScrapeBadger::FilterRuleResponse
• ScrapeBadger::FilterRuleUpdate
• ScrapeBadger::FilterRuleValidateRequest
• ScrapeBadger::FilterRuleValidateResponse
• ScrapeBadger::HTTPValidationError
• ScrapeBadger::PortalApiRoutersV1TwitterFilterRulesFilterRulePricingResponse
• ScrapeBadger::StreamMonitorCreate
• ScrapeBadger::StreamMonitorListResponse
• ScrapeBadger::StreamMonitorResponse
• ScrapeBadger::StreamMonitorUpdate
• ScrapeBadger::SubscriptionInfo
• ScrapeBadger::TweetDeliveryLogListResponse
• ScrapeBadger::TweetDeliveryLogResponse
• ScrapeBadger::ValidationError
• ScrapeBadger::ValidationErrorLocInner
• ScrapeBadger::WebhookCreate
• ScrapeBadger::WebhookListItem
• ScrapeBadger::WebhookListResponse
• ScrapeBadger::WebhookResponse
• ScrapeBadger::WebhookTestRequest
• ScrapeBadger::WebhookTestResponse

Authentication schemes defined for the API:

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header