---
title: "Ruby SDK - WhoisFreaks"
slug: "/integrations/ruby"
description: "Comprehensive Ruby SDK documentation for the WhoisFreaks API. Install via RubyGems, authenticate, and call every endpoint with ready-to-run Ruby code samples."
---

## Authentication

Every WhoisFreaks API request requires an API key, passed as the`apiKey` query parameter. Each SDK exposes a configuration hook so you set the key once and it is attached to every request automatically.

### Get an API key

New to WhoisFreaks? Follow the step-by-step guide,[Getting Started with WhoisFreaks: How to Sign Up and Get Your API Key](https://whoisfreaks.com/resources/tutorial/getting-started-with-whoisfreaks-how-to-sign-up-and-get-your-api-key), which walks through account creation and locating your key.

In short:

*   Sign in at [billing.whoisfreaks.com](https://billing.whoisfreaks.com).
*   Copy your API key from the dashboard.
*   Keep it secret. Do not commit it to source control. Prefer an environment variable such as `WHOISFREAKS_API_KEY`.

## About

The official **WhoisFreaks Ruby SDK** — a complete client for WHOIS, DNS, SSL, domain availability, subdomain, IP geolocation, IP reputation, ASN, typosquatting, and domain reputation lookups, plus bulk database downloads. Query real-time and historical domain data, reverse WHOIS, and threat intelligence from Ruby with a single API key. Generated from the WhoisFreaks OpenAPI specification and published to RubyGems.

## Install

bash

```bash
gem install whoisfreaks
```

## Build from Source

Prefer to build the SDK yourself instead of installing from RubyGems? Clone the monorepo and build the Ruby package locally:

bash

```bash
git clone https://github.com/WhoisFreaks/whoisfreaks-ruby
cd whoisfreaks-ruby
gem build *.gemspec
gem install ./whoisfreaks-*.gem
```

## Getting Started

A complete walkthrough from an empty directory to a running program:

bash

```bash
mkdir whoisfreaks-test && cd whoisfreaks-test
gem install whoisfreaks
```

Create `main.rb`:

ruby

```ruby
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::WhoisApi.new
result = api.whois_live("example.com")
puts result
```

Run it:

bash

```bash
ruby main.rb
```

## Configure

See [Authentication](https://whoisfreaks.com/integrations/ruby#authentication) for how to obtain a key. Minimal setup:

ruby

```ruby
# Runnable example: Live WHOIS Lookup (GET /v2.0/whois/live)
# Parameters for whoisLive (GET /v2.0/whois/live):
#   - domainName (string, required)
#   - format (string (one of: json, xml), optional)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::WHOISApi.new
result = api.whois_live("example.com")
puts result
```

## Endpoints

### WHOIS

#### Live WHOIS Lookup

GET`/v2.0/whois/live`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| domainName | string | required | —   |
| format | string (one of: json, xml) | optional | —   |

ruby

```ruby
# Runnable example: Live WHOIS Lookup (GET /v2.0/whois/live)
# Parameters for whoisLive (GET /v2.0/whois/live):
#   - domainName (string, required)
#   - format (string (one of: json, xml), optional)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::WHOISApi.new
result = api.whois_live("example.com")
puts result
```

#### Bulk WHOIS Lookup

POST`/v2.0/bulkwhois/live`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| format | string (one of: json, xml) | optional | —   |
| body | BulkWhoisRequest | required | request body object |

ruby

```ruby
# Runnable example: Bulk WHOIS Lookup (POST /v2.0/bulkwhois/live)
# Parameters for bulkWhois (POST /v2.0/bulkwhois/live):
#   - format (string (one of: json, xml), optional)
#   - body: BulkWhoisRequest (required) -- request body object
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::WHOISApi.new
result = api.bulk_whois(WhoisFreaks::BulkWhoisRequest.new)
puts result
```

#### Historical WHOIS records for a domain

GET`/v2.0/whois/history`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| domainName | string | required | Domain to fetch historical WHOIS records for |
| page | integer | optional | Page number |
| format | string (one of: json, xml) | optional | —   |

ruby

```ruby
# Runnable example: Historical WHOIS records for a domain (GET /v2.0/whois/history)
# Parameters for whoisHistory (GET /v2.0/whois/history):
#   - domainName (string, required): Domain to fetch historical WHOIS records for
#   - page (integer, optional): Page number
#   - format (string (one of: json, xml), optional)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::WHOISApi.new
result = api.whois_history("example.com")
puts result
```

#### Reverse WHOIS lookup by keyword

GET`/v2.0/whois/reverse`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| keyword | string | required | Keyword to search across WHOIS records |
| page | integer | optional | Page number |
| format | string (one of: json, xml) | optional | —   |

ruby

```ruby
# Runnable example: Reverse WHOIS lookup by keyword (GET /v2.0/whois/reverse)
# Parameters for whoisReverse (GET /v2.0/whois/reverse):
#   - keyword (string, required): Keyword to search across WHOIS records
#   - page (integer, optional): Page number
#   - format (string (one of: json, xml), optional)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::WHOISApi.new
result = api.whois_reverse("value")
puts result
```

### DNS

#### Live DNS Lookup

GET`/v2.0/dns/live`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| domainName | string | required | —   |
| ipAddress | string | required | Use for PTR lookups |
| type | string | required | all or comma-separated: A,MX,NS,TXT,SOA,SPF,AAAA,CNAME |
| format | string (one of: json, xml) | optional | —   |

ruby

```ruby
# Runnable example: Live DNS Lookup (GET /v2.0/dns/live)
# Parameters for dnsLive (GET /v2.0/dns/live):
#   - domainName (string, required)
#   - ipAddress (string, required): Use for PTR lookups
#   - type (string, required): all or comma-separated: A,MX,NS,TXT,SOA,SPF,AAAA,CNAME
#   - format (string (one of: json, xml), optional)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DNSApi.new
result = api.dns_live("example.com", "8.8.8.8", "value")
puts result
```

#### Historical DNS Lookup

GET`/v2.0/dns/historical`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| domainName | string | required | —   |
| type | string | required | —   |
| page | integer | optional | —   |
| format | string (one of: json, xml) | optional | —   |

ruby

```ruby
# Runnable example: Historical DNS Lookup (GET /v2.0/dns/historical)
# Parameters for dnsHistorical (GET /v2.0/dns/historical):
#   - domainName (string, required)
#   - type (string, required)
#   - page (integer, optional)
#   - format (string (one of: json, xml), optional)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DNSApi.new
result = api.dns_historical("example.com", "value")
puts result
```

#### Reverse DNS Lookup

GET`/v2.1/dns/reverse`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| value | string | required | IP, CIDR, or record value |
| type | string (one of: a, mx, cname, ns, aaaa, txt, soa) | required | —   |
| exact | boolean | optional | —   |
| page | integer | optional | —   |
| format | string (one of: json, xml) | optional | —   |

ruby

```ruby
# Runnable example: Reverse DNS Lookup (GET /v2.1/dns/reverse)
# Parameters for dnsReverse (GET /v2.1/dns/reverse):
#   - value (string, required): IP, CIDR, or record value
#   - type (string (one of: a, mx, cname, ns, aaaa, txt, soa), required)
#   - exact (boolean, optional)
#   - page (integer, optional)
#   - format (string (one of: json, xml), optional)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DNSApi.new
result = api.dns_reverse("value", "a", true)
puts result
```

#### Bulk DNS Lookup

POST`/v2.0/dns/bulk/live`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| type | string | required | —   |
| format | string (one of: json, xml) | optional | —   |
| body | DnsBulkRequest | required | request body object |

ruby

```ruby
# Runnable example: Bulk DNS Lookup (POST /v2.0/dns/bulk/live)
# Parameters for dnsBulk (POST /v2.0/dns/bulk/live):
#   - type (string, required)
#   - format (string (one of: json, xml), optional)
#   - body: DnsBulkRequest (required) -- request body object
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DNSApi.new
result = api.dns_bulk("value", WhoisFreaks::DnsBulkRequest.new)
puts result
```

### Domain Availability

#### Domain Availability Check with Suggestions

GET`/v2.0/domain/availability`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| domain | string | required | The domain name to check |
| sug | boolean | optional | Whether to return TLD suggestions alongside the queried domain. |
| count | integer | optional | Number of TLD suggestions to return when sug=true. Maximum is 100. |
| format | string (one of: json, xml) | optional | —   |

ruby

```ruby
# Runnable example: Domain Availability Check with Suggestions (GET /v2.0/domain/availability)
# Parameters for domainAvailabilityV2 (GET /v2.0/domain/availability):
#   - domain (string, required): The domain name to check
#   - sug (boolean, optional): Whether to return TLD suggestions alongside the queried domain.
#   - count (integer, optional): Number of TLD suggestions to return when sug=true. Maximum is 100.
#   - format (string (one of: json, xml), optional)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DomainAvailabilityApi.new
result = api.domain_availability_v2("example.com")
puts result
```

#### Bulk Domain Availability Check

POST`/v2.0/domain/availability`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| domain | string | optional | Required for TLD-mode bulk check (base domain). |
| format | string (one of: json, xml) | optional | —   |
| body | BulkDomainAvailabilityRequest | required | request body object |

ruby

```ruby
# Runnable example: Bulk Domain Availability Check (POST /v2.0/domain/availability)
# Parameters for bulkDomainAvailabilityV2 (POST /v2.0/domain/availability):
#   - domain (string, optional): Required for TLD-mode bulk check (base domain).
#   - format (string (one of: json, xml), optional)
#   - body: BulkDomainAvailabilityRequest (required) -- request body object
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DomainAvailabilityApi.new
result = api.bulk_domain_availability_v2(WhoisFreaks::BulkDomainAvailabilityRequest.new)
puts result
```

### Typosquatting

#### Typosquatting Lookup

GET`/v3.0/domain/typos`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| keyword | string | optional | —   |
| pattern | string | optional | —   |
| pageToken | string | optional | —   |

ruby

```ruby
# Runnable example: Typosquatting Lookup (GET /v3.0/domain/typos)
# Parameters for typosquatting (GET /v3.0/domain/typos):
#   - keyword (string, optional)
#   - pattern (string, optional)
#   - pageToken (string, optional)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::TyposquattingApi.new
result = api.typosquatting()
puts result
```

### SSL

#### SSL Certificate Lookup

GET`/v1.0/ssl/live`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| domainName | string | required | —   |
| chain | boolean | optional | —   |
| sslRaw | boolean | optional | —   |
| format | string (one of: json, xml) | optional | —   |

ruby

```ruby
# Runnable example: SSL Certificate Lookup (GET /v1.0/ssl/live)
# Parameters for sslLookup (GET /v1.0/ssl/live):
#   - domainName (string, required)
#   - chain (boolean, optional)
#   - sslRaw (boolean, optional)
#   - format (string (one of: json, xml), optional)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::SSLApi.new
result = api.ssl_lookup("example.com")
puts result
```

### Geolocation

#### IP Geolocation Lookup

GET`/v1.0/geolocation`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| ip  | string | required | —   |

ruby

```ruby
# Runnable example: IP Geolocation Lookup (GET /v1.0/geolocation)
# Parameters for geolocation (GET /v1.0/geolocation):
#   - ip (string, required)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::GeolocationApi.new
result = api.geolocation("8.8.8.8")
puts result
```

#### Bulk IP Geolocation

POST`/v1.0/geolocation`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| body | BulkGeolocationRequest | required | request body object |

ruby

```ruby
# Runnable example: Bulk IP Geolocation (POST /v1.0/geolocation)
# Parameters for bulkGeolocation (POST /v1.0/geolocation):
#   - body: BulkGeolocationRequest (required) -- request body object
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::GeolocationApi.new
result = api.bulk_geolocation(WhoisFreaks::BulkGeolocationRequest.new)
puts result
```

### Subdomains

#### Subdomains Lookup

GET`/v1.0/subdomains`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| domain | string | required | —   |
| after | string | optional | —   |
| before | string | optional | —   |
| status | string (one of: active, inactive) | optional | —   |
| page | integer | optional | —   |
| format | string (one of: json, xml) | optional | —   |

ruby

```ruby
# Runnable example: Subdomains Lookup (GET /v1.0/subdomains)
# Parameters for subdomains (GET /v1.0/subdomains):
#   - domain (string, required)
#   - after (string, optional)
#   - before (string, optional)
#   - status (string (one of: active, inactive), optional)
#   - page (integer, optional)
#   - format (string (one of: json, xml), optional)
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::SubdomainsApi.new
result = api.subdomains("example.com", "2000-01-01", Date.today.to_s)
puts result
```

### IP Reputation

#### IP Reputation Lookup

GET`/v1.0/security`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| ip  | string | required | —   |

ruby

```ruby
# Runnable example: IP Reputation Lookup (GET /v1.0/security)
# Parameters for ipReputation (GET /v1.0/security):
#   - ip (string, required)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::IPReputationApi.new
result = api.ip_reputation("8.8.8.8")
puts result
```

#### Bulk IP Reputation

POST`/v1.0/security`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| body | BulkIpReputationRequest | required | request body object |

ruby

```ruby
# Runnable example: Bulk IP Reputation (POST /v1.0/security)
# Parameters for bulkIpReputation (POST /v1.0/security):
#   - body: BulkIpReputationRequest (required) -- request body object
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::IPReputationApi.new
result = api.bulk_ip_reputation(WhoisFreaks::BulkIpReputationRequest.new)
puts result
```

### Domain Reputation

#### Domain Reputation Lookup

GET`/v1/domain/security`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| domainName | string | required | The domain name to assess |
| format | string (one of: json, xml) | optional | —   |

ruby

```ruby
# Runnable example: Domain Reputation Lookup (GET /v1/domain/security)
# Parameters for domainReputation (GET /v1/domain/security):
#   - domainName (string, required): The domain name to assess
#   - format (string (one of: json, xml), optional)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DomainReputationApi.new
result = api.domain_reputation("example.com")
puts result
```

### ASN WHOIS

#### ASN WHOIS Lookup

GET`/v2.0/asn-whois`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| asn | string | required | —   |
| format | string (one of: json, xml) | optional | —   |

ruby

```ruby
# Runnable example: ASN WHOIS Lookup (GET /v2.0/asn-whois)
# Parameters for asnWhois (GET /v2.0/asn-whois):
#   - asn (string, required)
#   - format (string (one of: json, xml), optional)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::ASNWHOISApi.new
result = api.asn_whois("AS15169")
puts result
```

### IP WHOIS

#### IP WHOIS Lookup

GET`/v1.0/ip-whois`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| ip  | string | required | —   |
| format | string (one of: json, xml) | optional | —   |

ruby

```ruby
# Runnable example: IP WHOIS Lookup (GET /v1.0/ip-whois)
# Parameters for ipWhois (GET /v1.0/ip-whois):
#   - ip (string, required)
#   - format (string (one of: json, xml), optional)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::IPWHOISApi.new
result = api.ip_whois("8.8.8.8")
puts result
```

### Account

#### Rotate API Key

GET`/v1.0/api-key/rotate`

ruby

```ruby
# Runnable example: Rotate API Key (GET /v1.0/api-key/rotate)
# Parameters for rotateApiKey (GET /v1.0/api-key/rotate):
#   (no parameters; the API key is set on the client)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::AccountApi.new
result = api.rotate_api_key()
puts result
```

#### Account Usage

GET`/v1.0/whoisapi/usage`

ruby

```ruby
# Runnable example: Account Usage (GET /v1.0/whoisapi/usage)
# Parameters for accountUsage (GET /v1.0/whoisapi/usage):
#   (no parameters; the API key is set on the client)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::AccountApi.new
result = api.account_usage()
puts result
```

#### Database File Status (Public)

GET`/v3.4/status`

ruby

```ruby
# Runnable example: Database File Status (Public) (GET /v3.4/status)
# Parameters for databaseFileStatus (GET /v3.4/status):
#   (no parameters; the API key is set on the client)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::AccountApi.new
result = api.database_file_status()
puts result
```

### Databases - Newly Registered

#### Newly Registered gTLD (CSV)

GET`/v3.1/download/domainer/gtld`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| whois | boolean | required | —   |
| date | string | optional | yyyy-MM-dd; omit for latest |
| tlds | string | optional | —   |

ruby

```ruby
# Runnable example: Newly Registered gTLD (CSV) (GET /v3.1/download/domainer/gtld)
# Parameters for dbNewlyGtld (GET /v3.1/download/domainer/gtld):
#   - whois (boolean, required)
#   - date (string, optional): yyyy-MM-dd; omit for latest
#   - tlds (string, optional)
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesNewlyRegisteredApi.new
result = api.db_newly_gtld(false, (Date.today - 1).to_s)
puts result
```

#### Newly Registered ccTLD (CSV)

GET`/v3.1/download/domainer/cctld`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| whois | boolean | required | —   |
| date | string | optional | yyyy-MM-dd; omit for latest |
| tlds | string | optional | —   |

ruby

```ruby
# Runnable example: Newly Registered ccTLD (CSV) (GET /v3.1/download/domainer/cctld)
# Parameters for dbNewlyCctld (GET /v3.1/download/domainer/cctld):
#   - whois (boolean, required)
#   - date (string, optional): yyyy-MM-dd; omit for latest
#   - tlds (string, optional)
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesNewlyRegisteredApi.new
result = api.db_newly_cctld(false, (Date.today - 1).to_s)
puts result
```

#### Newly Registered gTLD Cleaned WHOIS (CSV)

GET`/v3.1/download/domainer/gtld/cleaned`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: Newly Registered gTLD Cleaned WHOIS (CSV) (GET /v3.1/download/domainer/gtld/cleaned)
# Parameters for dbNewlyGtldCleaned (GET /v3.1/download/domainer/gtld/cleaned):
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesNewlyRegisteredApi.new
result = api.db_newly_gtld_cleaned((Date.today - 1).to_s)
puts result
```

#### Newly Registered ccTLD Cleaned WHOIS (CSV)

GET`/v3.1/download/domainer/cctld/cleaned`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: Newly Registered ccTLD Cleaned WHOIS (CSV) (GET /v3.1/download/domainer/cctld/cleaned)
# Parameters for dbNewlyCctldCleaned (GET /v3.1/download/domainer/cctld/cleaned):
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesNewlyRegisteredApi.new
result = api.db_newly_cctld_cleaned((Date.today - 1).to_s)
puts result
```

#### Newly Registered gTLD (JSON)

GET`/v3.1/domains/newly/gtld`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |
| tlds | string | optional | —   |

ruby

```ruby
# Runnable example: Newly Registered gTLD (JSON) (GET /v3.1/domains/newly/gtld)
# Parameters for dbNewlyGtldJson (GET /v3.1/domains/newly/gtld):
#   - date (string, optional): yyyy-MM-dd; omit for latest
#   - tlds (string, optional)
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesNewlyRegisteredApi.new
result = api.db_newly_gtld_json((Date.today - 1).to_s)
puts result
```

#### Newly Registered ccTLD (JSON)

GET`/v3.1/domains/newly/cctld`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |
| tlds | string | optional | —   |

ruby

```ruby
# Runnable example: Newly Registered ccTLD (JSON) (GET /v3.1/domains/newly/cctld)
# Parameters for dbNewlyCctldJson (GET /v3.1/domains/newly/cctld):
#   - date (string, optional): yyyy-MM-dd; omit for latest
#   - tlds (string, optional)
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesNewlyRegisteredApi.new
result = api.db_newly_cctld_json((Date.today - 1).to_s)
puts result
```

#### Newly Registered With DNS

GET`/v3.1/download/domainer/newly/dns`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: Newly Registered With DNS (GET /v3.1/download/domainer/newly/dns)
# Parameters for dbNewlyDns (GET /v3.1/download/domainer/newly/dns):
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesNewlyRegisteredApi.new
result = api.db_newly_dns((Date.today - 1).to_s)
puts result
```

### Databases - Expiring & Dropped

#### Expiring Domains

GET`/v3.1/download/domainer/expired`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| whois | boolean | required | —   |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: Expiring Domains (GET /v3.1/download/domainer/expired)
# Parameters for dbExpired (GET /v3.1/download/domainer/expired):
#   - whois (boolean, required)
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesExpiringDroppedApi.new
result = api.db_expired(false, (Date.today - 1).to_s)
puts result
```

#### Expiring Cleaned WHOIS

GET`/v3.1/download/domainer/expired/cleaned`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: Expiring Cleaned WHOIS (GET /v3.1/download/domainer/expired/cleaned)
# Parameters for dbExpiredCleaned (GET /v3.1/download/domainer/expired/cleaned):
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesExpiringDroppedApi.new
result = api.db_expired_cleaned((Date.today - 1).to_s)
puts result
```

#### Dropped Domains

GET`/v3.1/download/domainer/dropped`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| whois | boolean | required | —   |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: Dropped Domains (GET /v3.1/download/domainer/dropped)
# Parameters for dbDropped (GET /v3.1/download/domainer/dropped):
#   - whois (boolean, required)
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesExpiringDroppedApi.new
result = api.db_dropped(false, (Date.today - 1).to_s)
puts result
```

#### Dropped Domains (JSON)

GET`/v3.1/domains/dropped`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |
| tlds | string | optional | —   |

ruby

```ruby
# Runnable example: Dropped Domains (JSON) (GET /v3.1/domains/dropped)
# Parameters for dbDroppedJson (GET /v3.1/domains/dropped):
#   - date (string, optional): yyyy-MM-dd; omit for latest
#   - tlds (string, optional)
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesExpiringDroppedApi.new
result = api.db_dropped_json((Date.today - 1).to_s)
puts result
```

#### Dropped With Backlinks

GET`/v3.3/download/domainer/dropped/backlinks`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| whois | boolean | optional | —   |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: Dropped With Backlinks (GET /v3.3/download/domainer/dropped/backlinks)
# Parameters for dbDroppedBacklinks (GET /v3.3/download/domainer/dropped/backlinks):
#   - whois (boolean, optional)
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesExpiringDroppedApi.new
result = api.db_dropped_backlinks(false, (Date.today - 1).to_s)
puts result
```

### Databases - WHOIS

#### WHOIS Database Daily

GET`/v3.3/download/dbupdate/daily/domains/whois`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: WHOIS Database Daily (GET /v3.3/download/dbupdate/daily/domains/whois)
# Parameters for dbWhoisDaily (GET /v3.3/download/dbupdate/daily/domains/whois):
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesWHOISApi.new
result = api.db_whois_daily((Date.today - 1).to_s)
puts result
```

#### WHOIS Database Weekly

GET`/v3.3/download/dbupdate/weekly/domains/whois`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: WHOIS Database Weekly (GET /v3.3/download/dbupdate/weekly/domains/whois)
# Parameters for dbWhoisWeekly (GET /v3.3/download/dbupdate/weekly/domains/whois):
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesWHOISApi.new
result = api.db_whois_weekly((Date.today - 1).to_s)
puts result
```

#### WHOIS Database Monthly

GET`/v3.3/download/dbupdate/monthly/domains/whois`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: WHOIS Database Monthly (GET /v3.3/download/dbupdate/monthly/domains/whois)
# Parameters for dbWhoisMonthly (GET /v3.3/download/dbupdate/monthly/domains/whois):
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesWHOISApi.new
result = api.db_whois_monthly((Date.today - 1).to_s)
puts result
```

### Databases - DNS

#### DNS Database Daily

GET`/v3.2/download/dbupdate/daily/dns`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: DNS Database Daily (GET /v3.2/download/dbupdate/daily/dns)
# Parameters for dbDnsDaily (GET /v3.2/download/dbupdate/daily/dns):
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesDNSApi.new
result = api.db_dns_daily((Date.today - 1).to_s)
puts result
```

#### DNS Database Weekly

GET`/v3.2/download/dbupdate/weekly/dns`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: DNS Database Weekly (GET /v3.2/download/dbupdate/weekly/dns)
# Parameters for dbDnsWeekly (GET /v3.2/download/dbupdate/weekly/dns):
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesDNSApi.new
result = api.db_dns_weekly((Date.today - 1).to_s)
puts result
```

#### DNS Database Monthly

GET`/v3.2/download/dbupdate/monthly/dns`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: DNS Database Monthly (GET /v3.2/download/dbupdate/monthly/dns)
# Parameters for dbDnsMonthly (GET /v3.2/download/dbupdate/monthly/dns):
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesDNSApi.new
result = api.db_dns_monthly((Date.today - 1).to_s)
puts result
```

### Databases - Subdomains

#### Subdomains Daily

GET`/v3.2/download/dbupdate/daily/subdomains`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: Subdomains Daily (GET /v3.2/download/dbupdate/daily/subdomains)
# Parameters for dbSubdomainsDaily (GET /v3.2/download/dbupdate/daily/subdomains):
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesSubdomainsApi.new
result = api.db_subdomains_daily((Date.today - 1).to_s)
puts result
```

#### Subdomains Weekly

GET`/v3.2/download/dbupdate/weekly/subdomains`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: Subdomains Weekly (GET /v3.2/download/dbupdate/weekly/subdomains)
# Parameters for dbSubdomainsWeekly (GET /v3.2/download/dbupdate/weekly/subdomains):
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesSubdomainsApi.new
result = api.db_subdomains_weekly((Date.today - 1).to_s)
puts result
```

#### Subdomains Monthly

GET`/v3.2/download/dbupdate/monthly/subdomains`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | yyyy-MM-dd; omit for latest |

ruby

```ruby
# Runnable example: Subdomains Monthly (GET /v3.2/download/dbupdate/monthly/subdomains)
# Parameters for dbSubdomainsMonthly (GET /v3.2/download/dbupdate/monthly/subdomains):
#   - date (string, optional): yyyy-MM-dd; omit for latest
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesSubdomainsApi.new
result = api.db_subdomains_monthly((Date.today - 1).to_s)
puts result
```

### Databases - IP Geolocation

#### IP to Country Snapshot Status

GET`/v3.3/status/snapshot/ip/country`

ruby

```ruby
# Runnable example: IP to Country Snapshot Status (GET /v3.3/status/snapshot/ip/country)
# Parameters for dbIpCountryStatus (GET /v3.3/status/snapshot/ip/country):
#   (no parameters; the API key is set on the client)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesIPGeolocationApi.new
result = api.db_ip_country_status()
puts result
```

#### IP to Country Snapshot

GET`/v3.3/download/snapshot/ip/country`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | required | —   |

ruby

```ruby
# Runnable example: IP to Country Snapshot (GET /v3.3/download/snapshot/ip/country)
# Parameters for dbIpCountry (GET /v3.3/download/snapshot/ip/country):
#   - date (string, required)
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesIPGeolocationApi.new
result = api.db_ip_country((Date.today - 1).to_s)
puts result
```

#### IP to City Snapshot Status

GET`/v3.3/status/snapshot/ip/city`

ruby

```ruby
# Runnable example: IP to City Snapshot Status (GET /v3.3/status/snapshot/ip/city)
# Parameters for dbIpCityStatus (GET /v3.3/status/snapshot/ip/city):
#   (no parameters; the API key is set on the client)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesIPGeolocationApi.new
result = api.db_ip_city_status()
puts result
```

#### IP to City Snapshot

GET`/v3.3/download/snapshot/ip/city`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | required | —   |

ruby

```ruby
# Runnable example: IP to City Snapshot (GET /v3.3/download/snapshot/ip/city)
# Parameters for dbIpCity (GET /v3.3/download/snapshot/ip/city):
#   - date (string, required)
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesIPGeolocationApi.new
result = api.db_ip_city((Date.today - 1).to_s)
puts result
```

### Databases - ASN WHOIS

#### ASN WHOIS Snapshot

GET`/v3.3/download/snapshot/asn/whois`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | required | —   |

ruby

```ruby
# Runnable example: ASN WHOIS Snapshot (GET /v3.3/download/snapshot/asn/whois)
# Parameters for dbAsnWhois (GET /v3.3/download/snapshot/asn/whois):
#   - date (string, required)
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesASNWHOISApi.new
result = api.db_asn_whois((Date.today - 1).to_s)
puts result
```

#### ASN WHOIS Snapshot Status

GET`/v3.3/status/snapshot/asn/whois`

ruby

```ruby
# Runnable example: ASN WHOIS Snapshot Status (GET /v3.3/status/snapshot/asn/whois)
# Parameters for dbAsnWhoisStatus (GET /v3.3/status/snapshot/asn/whois):
#   (no parameters; the API key is set on the client)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesASNWHOISApi.new
result = api.db_asn_whois_status()
puts result
```

### Databases - IP WHOIS

#### IP WHOIS Snapshot

GET`/v3.3/download/snapshot/ip/whois`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | required | —   |

ruby

```ruby
# Runnable example: IP WHOIS Snapshot (GET /v3.3/download/snapshot/ip/whois)
# Parameters for dbIpWhois (GET /v3.3/download/snapshot/ip/whois):
#   - date (string, required)
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesIPWHOISApi.new
result = api.db_ip_whois((Date.today - 1).to_s)
puts result
```

#### IP WHOIS Snapshot Status

GET`/v3.3/status/snapshot/ip/whois`

ruby

```ruby
# Runnable example: IP WHOIS Snapshot Status (GET /v3.3/status/snapshot/ip/whois)
# Parameters for dbIpWhoisStatus (GET /v3.3/status/snapshot/ip/whois):
#   (no parameters; the API key is set on the client)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesIPWHOISApi.new
result = api.db_ip_whois_status()
puts result
```

### Databases - IP Security

#### IP Security Snapshot

GET`/v3.3/download/snapshot/ip/security`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | required | —   |

ruby

```ruby
# Runnable example: IP Security Snapshot (GET /v3.3/download/snapshot/ip/security)
# Parameters for dbIpSecurity (GET /v3.3/download/snapshot/ip/security):
#   - date (string, required)
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesIPSecurityApi.new
result = api.db_ip_security((Date.today - 1).to_s)
puts result
```

#### IP Security Snapshot Status

GET`/v3.3/status/snapshot/ip/security`

ruby

```ruby
# Runnable example: IP Security Snapshot Status (GET /v3.3/status/snapshot/ip/security)
# Parameters for dbIpSecurityStatus (GET /v3.3/status/snapshot/ip/security):
#   (no parameters; the API key is set on the client)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesIPSecurityApi.new
result = api.db_ip_security_status()
puts result
```

### Databases - Threat Feed

#### Download the daily phishing threat feed (CSV)

GET`/v3.4/download/threat-feed/phishing`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | Feed date (yyyy-MM-dd); defaults to latest available |

ruby

```ruby
# Runnable example: Download the daily phishing threat feed (CSV) (GET /v3.4/download/threat-feed/phishing)
# Parameters for downloadThreatFeedPhishing (GET /v3.4/download/threat-feed/phishing):
#   - date (string, optional): Feed date (yyyy-MM-dd); defaults to latest available
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesThreatFeedApi.new
result = api.download_threat_feed_phishing((Date.today - 1).to_s)
puts result
```

#### Download a sample of the phishing threat feed (CSV)

GET`/v3.4/download/threat-feed/phishing/sample`

ruby

```ruby
# Runnable example: Download a sample of the phishing threat feed (CSV) (GET /v3.4/download/threat-feed/phishing/sample)
# Parameters for downloadThreatFeedPhishingSample (GET /v3.4/download/threat-feed/phishing/sample):
#   (no parameters; the API key is set on the client)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesThreatFeedApi.new
result = api.download_threat_feed_phishing_sample()
puts result
```

#### Download the daily malware threat feed (CSV)

GET`/v3.4/download/threat-feed/malware`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | Feed date (yyyy-MM-dd); defaults to latest available |

ruby

```ruby
# Runnable example: Download the daily malware threat feed (CSV) (GET /v3.4/download/threat-feed/malware)
# Parameters for downloadThreatFeedMalware (GET /v3.4/download/threat-feed/malware):
#   - date (string, optional): Feed date (yyyy-MM-dd); defaults to latest available
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesThreatFeedApi.new
result = api.download_threat_feed_malware((Date.today - 1).to_s)
puts result
```

#### Download a sample of the malware threat feed (CSV)

GET`/v3.4/download/threat-feed/malware/sample`

ruby

```ruby
# Runnable example: Download a sample of the malware threat feed (CSV) (GET /v3.4/download/threat-feed/malware/sample)
# Parameters for downloadThreatFeedMalwareSample (GET /v3.4/download/threat-feed/malware/sample):
#   (no parameters; the API key is set on the client)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesThreatFeedApi.new
result = api.download_threat_feed_malware_sample()
puts result
```

#### Download the daily spam threat feed (CSV)

GET`/v3.4/download/threat-feed/spam`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| date | string | optional | Feed date (yyyy-MM-dd); defaults to latest available |

ruby

```ruby
# Runnable example: Download the daily spam threat feed (CSV) (GET /v3.4/download/threat-feed/spam)
# Parameters for downloadThreatFeedSpam (GET /v3.4/download/threat-feed/spam):
#   - date (string, optional): Feed date (yyyy-MM-dd); defaults to latest available
require 'date'
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesThreatFeedApi.new
result = api.download_threat_feed_spam((Date.today - 1).to_s)
puts result
```

#### Download a sample of the spam threat feed (CSV)

GET`/v3.4/download/threat-feed/spam/sample`

ruby

```ruby
# Runnable example: Download a sample of the spam threat feed (CSV) (GET /v3.4/download/threat-feed/spam/sample)
# Parameters for downloadThreatFeedSpamSample (GET /v3.4/download/threat-feed/spam/sample):
#   (no parameters; the API key is set on the client)
require 'whoisfreaks'

WhoisFreaks.configure do |config|
  config.api_key["apiKey"] = "YOUR_API_KEY"   # set once
end

api = WhoisFreaks::DatabasesThreatFeedApi.new
result = api.download_threat_feed_spam_sample()
puts result
```