whoisfreaks

WhoisFreaks - the Ruby gem for the WhoisFreaks API

Complete WhoisFreaks API — WHOIS, DNS, SSL, Geolocation, Typosquatting, IP Intelligence, Domain Reputation, and bulk database downloads. ## Authentication All requests require an apiKey query parameter.

Resources

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 0.5.0
  • Generator version: 7.11.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://whoisfreaks.com

Installation

Build a gem

To build the Ruby code into a gem:

gem build whoisfreaks.gemspec

Then either install the gem locally:

gem install ./whoisfreaks-0.5.0.gem

(for development, run gem install --dev ./whoisfreaks-0.5.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 'whoisfreaks', '~> 0.5.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'whoisfreaks', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

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

# Load the gem
require 'whoisfreaks'

# Setup authorization
WhoisFreaks.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['apiKey'] = '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['apiKey'] = 'Bearer'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = WhoisFreaks::ASNWHOISApi.new
api_key = 'api_key_example' # String | Your WHOISFreaks API key
asn = 'as15169' # String | 
opts = {
  format: 'json' # String | 
}

begin
  #ASN WHOIS Lookup
  result = api_instance.asn_whois(api_key, asn, opts)
  p result
rescue WhoisFreaks::ApiError => e
  puts "Exception when calling ASNWHOISApi->asn_whois: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.whoisfreaks.com

Class Method HTTP request Description
WhoisFreaks::ASNWHOISApi asn_whois GET /v2.0/asn-whois ASN WHOIS Lookup
WhoisFreaks::AccountApi account_usage GET /v1.0/whoisapi/usage Account Usage
WhoisFreaks::AccountApi database_file_status GET /v3.3/status Database File Status (Public)
WhoisFreaks::AccountApi rotate_api_key GET /v1.0/api-key/rotate Rotate API Key
WhoisFreaks::DNSApi dns_bulk POST /v2.0/dns/bulk/live Bulk DNS Lookup
WhoisFreaks::DNSApi dns_historical GET /v2.0/dns/historical Historical DNS Lookup
WhoisFreaks::DNSApi dns_live GET /v2.0/dns/live Live DNS Lookup
WhoisFreaks::DNSApi dns_reverse GET /v2.1/dns/reverse Reverse DNS Lookup
WhoisFreaks::DatabasesASNWHOISApi db_asn_whois GET /v3.3/download/snapshot/asn/whois ASN WHOIS Snapshot
WhoisFreaks::DatabasesASNWHOISApi db_asn_whois_status GET /v3.3/status/snapshot/asn/whois ASN WHOIS Snapshot Status
WhoisFreaks::DatabasesDNSApi db_dns_daily GET /v3.2/download/dbupdate/daily/dns DNS Database Daily
WhoisFreaks::DatabasesDNSApi db_dns_monthly GET /v3.2/download/dbupdate/monthly/dns DNS Database Monthly
WhoisFreaks::DatabasesDNSApi db_dns_weekly GET /v3.2/download/dbupdate/weekly/dns DNS Database Weekly
WhoisFreaks::DatabasesExpiringDroppedApi db_dropped GET /v3.1/download/domainer/dropped Dropped Domains
WhoisFreaks::DatabasesExpiringDroppedApi db_dropped_backlinks GET /v3.3/download/domainer/dropped/backlinks Dropped With Backlinks
WhoisFreaks::DatabasesExpiringDroppedApi db_dropped_json GET /v3.1/domains/dropped Dropped Domains (JSON)
WhoisFreaks::DatabasesExpiringDroppedApi db_expired GET /v3.1/download/domainer/expired Expiring Domains
WhoisFreaks::DatabasesExpiringDroppedApi db_expired_cleaned GET /v3.1/download/domainer/expired/cleaned Expiring Cleaned WHOIS
WhoisFreaks::DatabasesIPGeolocationApi db_ip_city GET /v3.3/download/snapshot/ip/city IP to City Snapshot
WhoisFreaks::DatabasesIPGeolocationApi db_ip_city_status GET /v3.3/status/snapshot/ip/city IP to City Snapshot Status
WhoisFreaks::DatabasesIPGeolocationApi db_ip_country GET /v3.3/download/snapshot/ip/country IP to Country Snapshot
WhoisFreaks::DatabasesIPGeolocationApi db_ip_country_status GET /v3.3/status/snapshot/ip/country IP to Country Snapshot Status
WhoisFreaks::DatabasesIPSecurityApi db_ip_security GET /v3.3/download/snapshot/ip/security IP Security Snapshot
WhoisFreaks::DatabasesIPSecurityApi db_ip_security_status GET /v3.3/status/snapshot/ip/security IP Security Snapshot Status
WhoisFreaks::DatabasesIPWHOISApi db_ip_whois GET /v3.3/download/snapshot/ip/whois IP WHOIS Snapshot
WhoisFreaks::DatabasesIPWHOISApi db_ip_whois_status GET /v3.3/status/snapshot/ip/whois IP WHOIS Snapshot Status
WhoisFreaks::DatabasesNewlyRegisteredApi db_newly_cctld GET /v3.1/download/domainer/cctld Newly Registered ccTLD (CSV)
WhoisFreaks::DatabasesNewlyRegisteredApi db_newly_cctld_cleaned GET /v3.1/download/domainer/cctld/cleaned Newly Registered ccTLD Cleaned WHOIS (CSV)
WhoisFreaks::DatabasesNewlyRegisteredApi db_newly_cctld_json GET /v3.1/domains/newly/cctld Newly Registered ccTLD (JSON)
WhoisFreaks::DatabasesNewlyRegisteredApi db_newly_dns GET /v3.1/download/domainer/newly/dns Newly Registered With DNS
WhoisFreaks::DatabasesNewlyRegisteredApi db_newly_gtld GET /v3.1/download/domainer/gtld Newly Registered gTLD (CSV)
WhoisFreaks::DatabasesNewlyRegisteredApi db_newly_gtld_cleaned GET /v3.1/download/domainer/gtld/cleaned Newly Registered gTLD Cleaned WHOIS (CSV)
WhoisFreaks::DatabasesNewlyRegisteredApi db_newly_gtld_json GET /v3.1/domains/newly/gtld Newly Registered gTLD (JSON)
WhoisFreaks::DatabasesSubdomainsApi db_subdomains_daily GET /v3.2/download/dbupdate/daily/subdomains Subdomains Daily
WhoisFreaks::DatabasesSubdomainsApi db_subdomains_monthly GET /v3.2/download/dbupdate/monthly/subdomains Subdomains Monthly
WhoisFreaks::DatabasesSubdomainsApi db_subdomains_weekly GET /v3.2/download/dbupdate/weekly/subdomains Subdomains Weekly
WhoisFreaks::DatabasesWHOISApi db_whois_daily GET /v3.3/download/dbupdate/daily/domains/whois WHOIS Database Daily
WhoisFreaks::DatabasesWHOISApi db_whois_monthly GET /v3.3/download/dbupdate/monthly/domains/whois WHOIS Database Monthly
WhoisFreaks::DatabasesWHOISApi db_whois_weekly GET /v3.3/download/dbupdate/weekly/domains/whois WHOIS Database Weekly
WhoisFreaks::DomainAvailabilityApi bulk_domain_availability_v2 POST /v2.0/domain/availability Bulk Domain Availability Check
WhoisFreaks::DomainAvailabilityApi domain_availability_v2 GET /v2.0/domain/availability Domain Availability Check with Suggestions
WhoisFreaks::DomainReputationApi domain_reputation GET /v1/domain/security Domain Reputation Lookup
WhoisFreaks::GeolocationApi bulk_geolocation POST /v1.0/geolocation Bulk IP Geolocation
WhoisFreaks::GeolocationApi geolocation GET /v1.0/geolocation IP Geolocation Lookup
WhoisFreaks::IPReputationApi bulk_ip_reputation POST /v1.0/security Bulk IP Reputation
WhoisFreaks::IPReputationApi ip_reputation GET /v1.0/security IP Reputation Lookup
WhoisFreaks::IPWHOISApi ip_whois GET /v1.0/ip-whois IP WHOIS Lookup
WhoisFreaks::SSLApi ssl_lookup GET /v1.0/ssl/live SSL Certificate Lookup
WhoisFreaks::SubdomainsApi subdomains GET /v1.0/subdomains Subdomains Lookup
WhoisFreaks::TyposquattingApi typosquatting GET /v3.0/domain/typos Typosquatting Lookup
WhoisFreaks::WHOISApi bulk_whois POST /v2.0/bulkwhois/live Bulk WHOIS Lookup
WhoisFreaks::WHOISApi whois_historical_or_reverse GET /v1.0/whois WHOIS Historical or Reverse Lookup
WhoisFreaks::WHOISApi whois_live GET /v2.0/whois/live Live WHOIS Lookup

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: API key
  • API key parameter name: apiKey
  • Location: URL query string