### Example Request (Python)

Source: https://whoisfreaks.com/products/dns-checker-api

Demonstrates how to make a live DNS lookup request using Python with the 'requests' library.

```Python
import requests

api_key = 'YOUR_API_KEY'
domain_name = 'example.com'
record_type = 'MX,TXT'

url = f'https://api.whoisfreaks.com/v2.0/dns/live?apiKey={api_key}&domainName={domain_name}&type={record_type}'

response = requests.get(url)

if response.status_code == 200:
    print('DNS Data:', response.json())
else:
    print(f'Error fetching DNS data: {response.status_code} - {response.text}')

```

--------------------------------

### Example Request (Shell)

Source: https://whoisfreaks.com/products/dns-checker-api

Demonstrates how to make a live DNS lookup request using a shell command with curl.

```Shell
curl "https://api.whoisfreaks.com/v2.0/dns/live?apiKey=YOUR_API_KEY&domainName=example.com&type=A,MX"
```

--------------------------------

### Example Request (Node.js)

Source: https://whoisfreaks.com/products/dns-checker-api

Demonstrates how to make a live DNS lookup request using Node.js with the 'axios' library.

```Node.js
const axios = require('axios');

const apiKey = 'YOUR_API_KEY';
const domainName = 'example.com';
const recordType = 'A,AAAA';

axios.get(`https://api.whoisfreaks.com/v2.0/dns/live?apiKey=${apiKey}&domainName=${domainName}&type=${recordType}`)
  .then(response => {
    console.log('DNS Data:', response.data);
  })
  .catch(error => {
    console.error('Error fetching DNS data:', error.response ? error.response.data : error.message);
  });

```

--------------------------------

### Domain Availability API (GET)

Source: https://whoisfreaks.com/products/domain-availability-api

Checks the availability of a single domain and optionally provides suggestions. Requires an API key. Supports specifying the number of suggestions and output format.

```APIDOC
API Endpoint: GET https://api.whoisfreaks.com/v1.0/domain/availability

Description:
Checks if a domain is available for registration and can provide domain suggestions.

Query Parameters:
* Required:
  - apiKey (string): Your API key obtained from the billing dashboard.
  - domain (string): The domain name to check availability for.
* Optional:
  - sug (boolean): If true, returns domain suggestions. Defaults to false.
  - count (integer): The desired number of suggestions when 'sug' is true. Defaults to 5.
  - format (string): The desired response format. Available values: JSON, XML. Defaults to JSON.

Responses:
- 200 OK: Successful request.
- 400 Bad Request: Invalid domain name parameters.
- 401 Unauthorized: Invalid, inactive, or expired API key, or insufficient subscription/credits.
- 403 Forbidden: Unavailable domain extension or domain belongs to an inactive TLD.
- 408 Request Timeout: Unable to fetch WHOIS data.
- 412 Precondition Failed: Exceeded API plan request limit.
- 413 Payload Too Large: Exceeded API credit requests or surcharge requests limit.
- 429 Too Many Requests: Maximum request limit reached.
- 500 Internal Server Error: Server encountered an error.
- 503 Service Unavailable: The service is temporarily unavailable.
- 504 Gateway Timeout: Request timed out.

Example Usage:
GET https://api.whoisfreaks.com/v1.0/domain/availability?apiKey=YOUR_API_KEY&domain=whoisfreaks.com
GET https://api.whoisfreaks.com/v1.0/domain/availability?apiKey=YOUR_API_KEY&domain=whoisfreaks.com&sug=true&count=10
```

--------------------------------

### Sample File Downloads

Source: https://whoisfreaks.com/products/newly-registered-domains

Download sample files for newly registered gTLDs and ccTLDs, including WHOIS data. These samples are provided in compressed CSV format.

```APIDOC
Sample Files:
- Download sample of newly registered gTLDs whois file from here: https://files.whoisfreaks.com/v3.1/download/domainer/sample/gtld?whois=true
- Download sample of newly registered ccTLDs whois file from here: https://files.whoisfreaks.com/v3.1/download/domainer/sample/cctld?whois=true
```

--------------------------------

### Geolocation API GET Endpoint for Single IP Lookup

Source: https://whoisfreaks.com/products/ip-geolocation-api

Fetches geolocation data for a single IP address using a GET request. Requires an API key as a query parameter and the IP address to look up. Handles various success and error responses.

```APIDOC
Endpoint: GET https://api.whoisfreaks.com/v1.0/geolocation
Description: Retrieves geolocation data for a single IP address.
Parameters:
  apiKey (string, required): Your API key obtained from the billing dashboard.
  ip (string, required): The IP address for which to fetch geolocation data.
Responses:
  200 OK: Successful retrieval of geolocation data.
  400 Bad Request: Invalid IP address format.
  401 Unauthorized: Invalid, inactive, or expired API key, or insufficient subscription/credits.
  404 Not Found: Record not found.
  405 Method Not Allowed: Incorrect HTTP method used.
  408 Request Timeout: Unable to fetch WHOIS data.
  412 Precondition Failed: Exceeded API plan request limit.
  413 Payload Too Large: Exceeded API credit limit or surcharge limit.
  423 Locked: IP address is from a bogon IP range.
  429 Too Many Requests: Maximum request limit reached.
  499 Client Closed Request: Client closed the request.
  500 Internal Server Error: Server encountered an error.
  502 Bad Gateway: Bad gateway response.
  503 Service Unavailable: Service is unavailable.
  504 Gateway Timeout: Request timed out.
  505 HTTP Version Not Supported: Unsupported HTTP version.
```

```Shell
GET "https://api.whoisfreaks.com/v1.0/geolocation?apiKey=API_KEY&ip=8.8.8.8"
```

--------------------------------

### Download Newly Registered DNS Sample

Source: https://whoisfreaks.com/products/newly-registered-domains

Provides a link to download a sample file of newly registered DNS data. This is useful for understanding the file structure and content before making API requests.

```APIDOC
Sample File Download:
  https://files.whoisfreaks.com/v3.1/download/domainer/sample/newly/dns

Format:
  The sample file is typically provided in a compressed format (e.g., .gz) and contains example DNS registration data.
```

--------------------------------

### Download Newly Registered Domain List

Source: https://whoisfreaks.com/products/newly-registered-domains

Provides a direct link to download a sample list of newly registered domain names, useful for market analysis, brand protection, and threat intelligence.

```URL
https://files.whoisfreaks.com/v3.1/download/domainer/sample/gtld?whois=true
```

--------------------------------

### API GET Request for Expiring Domains (Cleaned WHOIS)

Source: https://whoisfreaks.com/products/expiring-dropped-domains

Provides the API endpoint and parameters for downloading a sample file of expiring domains with cleaned WHOIS data. It outlines the authorization process and the structure for accessing this specific dataset.

```APIDOC
## Authorization
You can make authorized requests to our API by passing API key as a query parameter. To get your API key, login to our billing dashboard and get your API key! If your API key has been compromised, you can change it by clicking on reset button in billing dashboard.

#### Sample File:
* Download sample of expiring cleaned whois file from [**here**](https://files.whoisfreaks.com/v3.1/download/domainer/sample/expired/cleaned).

API GET

CSV Format

https://files.whoisfreaks.com/v3.1/download/domainer/expired/cleaned?apiKey=API_KEY&date=

---
```

--------------------------------

### Newly Registered Domains Documentation

Source: https://whoisfreaks.com/products/brand-monitoring

Documentation for accessing and analyzing newly registered domain names. Includes options for retrieving WHOIS data for these domains.

```APIDOC
Newly Registered Domains:
  - With WHOIS data: /products/newly-registered-domains#with_whois
```

--------------------------------

### Security Lookup API (GET)

Source: https://whoisfreaks.com/products/security-api

Retrieve security response details for a single IP address. Requires an API key for authentication and the IP address as a query parameter. Returns various status codes indicating success or specific errors.

```APIDOC
API Endpoint:
GET https://api.whoisfreaks.com/v1.0/security

Query Parameters:
* apiKey (Required): Retrieve your API key from the billing dashboard.
* ip (Required): The IP address for which you want to retrieve the security response details.

Responses:
200 OK
400 IP address 'X.X.X.X' is not valid.
401 Provided API key is invalid.
401 Provided API key is inactive.
401 Please buy a subscription plan or add api credits.
401 Your subscription is deactivated.
401 Repeated payment failures.
401 Your account is deactivated.
401 Suspicious Activity.
404 Record not found.
405 Method not allowed.
408 Unable to fetch whois data.
412 Exceeded the limit of api plan requests.
413 Exceeded the limit of api credits requests.
413 Exceeded the limit of surcharge requests.
423 IP address is from a bogon ip ranges.
429 Maximum request limit reached.
499 Client closed request.
500 Internal Server error.
502 Bad gateway.
503 Service is unavailable.
504 Request is timed-out.
505 Unsupported HTTP Version.
```

--------------------------------

### API Product Documentation Links

Source: https://whoisfreaks.com/products/dns-checker-api

Provides direct links to the documentation for various WhoisFreaks products, covering their specific API functionalities and endpoints.

```APIDOC
Whois API: /products/whois-api#live_lookup
Domain Availability API: /products/domain-availability-api#domain_availability_lookup
SSL Certificate Lookup API: /products/ssl-certificate-api#ssl_live_lookup
DNS API: /products/dns-checker-api#live_dns_lookup
Subdomains Lookup API: /products/subdomains-api#subdomains_lookup_api
Security Lookup API: /products/security-api#security_lookup
Geolocation Lookup API: /products/ip-geolocation-api#geolocation_lookup
IP Whois Lookup API: /products/whois-api#ip_lookup
ASN Whois Lookup API: /products/whois-api#asn_lookup
Newly Registered Domains: /products/newly-registered-domains#with_whois
Expiring & Deleted Domains: /products/expiring-dropped-domains#expiring_with_whois
Whois Database: /products/whois-database#whois_database
DNS Database: /products/dns-database#dns_database
```

--------------------------------

### API GET Request for Dropped Domains (JSON)

Source: https://whoisfreaks.com/products/expiring-dropped-domains

This endpoint retrieves dropped domain data in JSON format. It requires an API key and supports an optional date parameter. You can also specify top-level domains (TLDs) to filter the results.

```APIDOC
API GET Request for Dropped Domains (JSON)

Endpoint:
https://files.whoisfreaks.com/v3.1/domains/dropped

Query Parameters:
* Required:
  - apiKey: Your API key obtained from the billing dashboard.
* Optional:
  - date: The date parameter is optional. If not specified, the most recent data is fetched. If provided, use the format (yyyy-MM-dd).
  - tlds: A comma-separated string of top-level domains to filter results (e.g., `com,us`).

Responses:
- 200 OK: Successful retrieval of the JSON data.
- 400 Bad Request: Provided date is too old.
- 401 Unauthorized: Api record not found, API key inactive, domainer package inactive, download limit exceeded, suspicious activity, or insufficient plan.
- 404 Not Found: Resources are not available for the specified date.
- 413 Payload Too Large: Please upgrade your plan.

Authorization:
Requests must include your API key as a query parameter (`apiKey`).
```

--------------------------------

### API GET Request for Expired Domains (without WHOIS)

Source: https://whoisfreaks.com/products/expiring-dropped-domains

Details the API endpoint and query parameters for retrieving expired domains data without WHOIS information. It highlights the `whois=false` parameter and lists required/optional parameters and potential response codes.

```APIDOC
## Authorization
You can make authorized requests to our API by passing API key as a query parameter. To get your API key, login to our billing dashboard and get your API key!
If your API key has been compromised, you can change it by clicking on reset button in billing dashboard.

#### Sample File:
* Download sample of expired domains file from [**here**](https://files.whoisfreaks.com/v3.1/download/domainer/sample/expired?whois=false).

API GET

CSV Format

https://files.whoisfreaks.com/v3.1/download/domainer/expired?whois=false&apiKey=API_KEY&date=

---

### CSV Format

Query Parameters

---
* Required

  apiKeyGet your API key from our billing dashboard.

  whoisWhois is a required and a boolean value parameter. Set `whois = false` to retrieve a CSV of expired domains without whois information. Default value is `true`.
* Optional

  dateDate parameter is optional. The most recent data will be fetched if the link doesn't have a date specified. If you choose to provide a date, use the format (yyyy-MM-dd).

Responses

---
200
OK

401
Api record not found.
401
Provided API key is inactive.
401
Please buy domainer package.
401
Your domainer package plan is inactive.
401
You cannot download file.
401
You have exceeded the download limit of 20000.
401
Suspicious Activity.

404
File is not available of this date.
404
Resources are not available of this date.

413
Please upgrade your plans.
```

```Shell
GET https://files.whoisfreaks.com/v3.1/download/domainer/expired?whois=false&apiKey=YOUR_API_KEY&date=YYYY-MM-DD
```

--------------------------------

### API Rate Limiting and Credits

Source: https://whoisfreaks.com/products/domain-availability-api

Outlines the API credit system and rate limiting policies for new and paid users. It details free credits, request limits per minute for different API types (Live, Bulk, Historical/Reverse), and how these limits are structured across various subscription tiers.

```APIDOC
API Credits and Rate Limiting:
  New User Credits: 500 API credits.
  Rate Limiting (New Users):
    - Live APIs: 10 requests per minute.
    - Bulk Domain Lookup: 5 requests per minute.
    - Reverse/Historical Endpoints: 1 request per minute.

  Paid Plans Rate Limiting:
  Rate limiting applies to all paid plans, with limits varying by plan tier.

  API Credit Tiers (Example for API Credits Plan):
  | Credits   | Live-rpm | Bulk-rpm | Historical/Reverse-rpm |
  |-----------|----------|----------|------------------------|
  | 5000      | 20       | 8        | 3                      |
  | 15000     | 35       | 12       | 5                      |
  | 50000     | 80       | 20       | 10                     |
  | 150000    | 120      | 25       | 15                     |
  | 450000    | 150      | 35       | 20                     |
  | 1000000   | 200      | 50       | 25                     |
  | 3000000   | 300      | 70       | 35                     |

  Rate Limit Definitions:
  - Live-rpm: Requests per minute for live Whois lookup, domain availability, SSL certificate lookup, and DNS lookup endpoints.
  - Bulk-rpm: Requests per minute for bulk domain Whois lookup endpoint.
  - Historical/Reverse-rpm: Requests per minute for historical and reverse Whois API endpoints.

  Error Handling: Exceeding request per minute limits results in an HTTP error code 429.
```

--------------------------------

### API GET Request for Expired Domains (with WHOIS)

Source: https://whoisfreaks.com/products/expiring-dropped-domains

Specifies the API endpoint and query parameters for retrieving expired domains data, including WHOIS information. It details required and optional parameters like apiKey and date, along with possible HTTP response codes.

```APIDOC
API GET

CSV Format

https://files.whoisfreaks.com/v3.1/download/domainer/expired?apiKey=API_KEY&date=

---

### CSV Format

Query Parameters

---
* Required

  apiKeyGet your API key from our billing dashboard.
* Optional

  dateDate parameter is optional. The most recent data will be fetched if the link doesn't have a date specified. If you choose to provide a date, use the format (yyyy-MM-dd).

Responses

---
200
OK

401
Api record not found.
401
Provided API key is inactive.
401
Please buy domainer package.
401
Your domainer package plan is inactive.
401
You cannot download file.
401
You have exceeded the download limit of 20000.
401
Suspicious Activity.

404
File is not available of this date.
404
Resources are not available of this date.

413
Please upgrade your plans.
```

```Shell
GET https://files.whoisfreaks.com/v3.1/download/domainer/expired?apiKey=YOUR_API_KEY&date=YYYY-MM-DD
```

--------------------------------

### API Credits and Rate Limiting

Source: https://whoisfreaks.com/products/whois-api

Outlines the API credit system for new users and the associated rate limits. New users receive 500 API credits. Rate limits are applied per minute: 10 requests for Live APIs, 5 requests for Bulk Domain Lookup, and 1 request for Reverse/Historical Endpoints.

```APIDOC
API Credits and Rate Limiting:
  - New User Credits: 500 API credits.
  - Rate Limits (per minute):
    - Live APIs: 10 requests/minute
    - Bulk Domain Lookup: 5 requests/minute
    - Reverse/Historical Endpoints: 1 request/minute
```

--------------------------------

### API GET Request for Dropped Domains (CSV without Whois)

Source: https://whoisfreaks.com/products/expiring-dropped-domains

This endpoint retrieves a CSV file containing dropped domain data, excluding detailed WHOIS information. It requires an API key and supports an optional date parameter. The `whois` parameter must be set to `false` for this output.

```APIDOC
API GET Request for Dropped Domains (CSV without Whois)

Endpoint:
https://files.whoisfreaks.com/v3.1/download/domainer/dropped

Query Parameters:
* Required:
  - apiKey: Your API key obtained from the billing dashboard.
  - whois: A boolean value. Set to `false` to retrieve a CSV file of dropped domains (without full WHOIS).
* Optional:
  - date: The date parameter is optional. If not specified, the most recent data is fetched. If provided, use the format (yyyy-MM-dd).

Responses:
- 200 OK: Successful retrieval of the CSV file.
- 400 Bad Request: Provided date is too old.
- 401 Unauthorized: Api record not found, API key inactive, domainer package inactive, download limit exceeded, suspicious activity, or insufficient plan.
- 404 Not Found: File or resources are not available for the specified date.
- 413 Payload Too Large: Please upgrade your plan.

Authorization:
Requests must include your API key as a query parameter (`apiKey`).

Sample File:
Download sample of dropped domains file from [here](https://files.whoisfreaks.com/v3.1/download/domainer/sample/dropped?whois=false).
```

--------------------------------

### DNS Database Documentation

Source: https://whoisfreaks.com/products/brand-monitoring

Documentation for the DNS Database, providing access to DNS records. Details how to query the DNS database.

```APIDOC
DNS Database:
  - DNS Database Access: /products/dns-database#dns_database
```

--------------------------------

### Whois Database Documentation

Source: https://whoisfreaks.com/products/brand-monitoring

Information on accessing the Whois Database, a comprehensive collection of WHOIS records. Details how to query the database.

```APIDOC
Whois Database:
  - Whois Database Access: /products/whois-database#whois_database
```

--------------------------------

### API GET Request for Dropped Domains (CSV with Whois)

Source: https://whoisfreaks.com/products/expiring-dropped-domains

This endpoint retrieves a CSV file containing dropped domain data, including complete WHOIS information. It requires an API key and supports an optional date parameter for filtering. The `whois` parameter must be set to `true` for this specific output.

```APIDOC
API GET Request for Dropped Domains (CSV with Whois)

Endpoint:
https://files.whoisfreaks.com/v3.1/download/domainer/dropped

Query Parameters:
* Required:
  - apiKey: Your API key obtained from the billing dashboard.
  - whois: A boolean value. Set to `true` to retrieve a CSV file with complete WHOIS information.
* Optional:
  - date: The date parameter is optional. If not specified, the most recent data is fetched. If provided, use the format (yyyy-MM-dd).

Responses:
- 200 OK: Successful retrieval of the CSV file.
- 400 Bad Request: Provided date is too old.
- 401 Unauthorized: Api record not found, API key inactive, domainer package inactive, download limit exceeded, suspicious activity, or insufficient plan.
- 404 Not Found: File or resources are not available for the specified date.
- 413 Payload Too Large: Please upgrade your plan.

Authorization:
Requests must include your API key as a query parameter (`apiKey`).

Sample File:
Download sample of dropped domains' whois file from [here](https://files.whoisfreaks.com/v3.1/download/domainer/sample/dropped?whois=true).
```

--------------------------------

### API Authorization and Sample File Download

Source: https://whoisfreaks.com/products/expiring-dropped-domains

Details how to authorize API requests using an API key and provides a link to download a sample file of expired domains with WHOIS information. This is crucial for understanding the data format and structure before making live requests.

```APIDOC
## Authorization
You can make authorized requests to our API by passing API key as a query parameter. To get your API key, login to our billing dashboard and get your API key!
If your API key has been compromised, you can change it by clicking on reset button in billing dashboard.

#### Sample File:
* Download sample of expired domains file from [**here**](https://files.whoisfreaks.com/v3.1/download/domainer/sample/expired?whois=true).
```

--------------------------------

### Domain Availability API Documentation

Source: https://whoisfreaks.com/products/brand-monitoring

Documentation for the Domain Availability API, which enables checking the registration status of domain names. It provides details on how to perform domain availability lookups.

```APIDOC
Domain Availability API:
  - Domain Availability Lookup: /products/domain-availability-api#domain_availability_lookup
```

--------------------------------

### DNS API Documentation

Source: https://whoisfreaks.com/products/brand-monitoring

Information regarding the DNS API, which facilitates DNS record lookups. The documentation covers live DNS lookups.

```APIDOC
DNS API:
  - Live DNS Lookup: /products/dns-checker-api#live_dns_lookup
```

--------------------------------

### API Authorization

Source: https://whoisfreaks.com/products/newly-registered-domains

Explains how to authorize API requests using an API key. Details on obtaining, using, and resetting the API key are provided.

```APIDOC
Authorization Method:
  API Key as a query parameter.

Obtaining API Key:
  Login to the billing dashboard to get your API key.

Resetting API Key:
  If your API key is compromised, you can reset it via the billing dashboard.

Usage:
  Append `?apiKey=YOUR_API_KEY` to your API requests.
```

--------------------------------

### Credit Usage API

Source: https://whoisfreaks.com/products/domain-availability-api

Documentation for the Credit Usage API, which is part of the API Packages offering. This API likely allows users to monitor and manage their API credit consumption.

```APIDOC
Credit Usage API:
  - Provides information on API credit consumption.
  - Details usage patterns and remaining credits.
```

--------------------------------

### Whois API Documentation

Source: https://whoisfreaks.com/products/brand-monitoring

Provides documentation for the Whois API, covering live lookups, IP lookups, and ASN lookups. This API allows users to retrieve detailed WHOIS information for domain names and IP addresses.

```APIDOC
Whois API:
  - Live Lookup: /products/whois-api#live_lookup
  - IP Lookup: /products/whois-api#ip_lookup
  - ASN Lookup: /products/whois-api#asn_lookup
```

--------------------------------

### Domain Monitoring Documentation

Source: https://whoisfreaks.com/products/brand-monitoring

Information on the Domain Monitoring product, which helps users track changes and activities related to their domain portfolio.

```APIDOC
Domain Monitoring:
  - Product Page: /products/domain-monitoring
```

--------------------------------

### Security API Documentation

Source: https://whoisfreaks.com/products/security-api

Provides details on the Security API, including methods for security lookups, bulk security checks, and credit usage. This API helps in detecting VPN/proxy usage, assessing threat scores, and retrieving network details for IP addresses.

```APIDOC
Security API Documentation:

Security Lookup:
  Performs a security check on a single IP address.
  - Detects VPN and Proxy usage, including anonymizer type and provider.
  - Provides a composite threat score based on various risk signals.
  - Returns network details like AS Number and organization.
  - Input: IP Address (IPv4 or IPv6)
  - Output: Security details, threat score, network information.

Bulk Security Lookup:
  Performs batch lookups for multiple IP addresses in a single request.
  - Supports up to 100 IP addresses per request.
  - Efficiently checks VPN/proxy status, threat scores, and network details for a list of IPs.
  - Input: List of IP Addresses (IPv4 or IPv6)
  - Output: List of security details, threat scores, and network information corresponding to each input IP.

Credit Usage API:
  Provides information on the usage of API credits.
  - Allows users to monitor their consumption of API resources.
  - Input: User/API Key
  - Output: Credit balance, usage history.
```

--------------------------------

### API Rate Limits by Credits (Per Minute)

Source: https://whoisfreaks.com/products/dns-checker-api

Defines the request per minute (rpm) limits for various API plans based on credit tiers. This table specifies limits for Live, Bulk, and Historical/Reverse API endpoints.

```APIDOC
API Credits Rate Limits:

| Credits | Live-rpm | Bulk-rpm | Historical/Reverse-rpm |
| --- | --- | --- | --- |
| 5000 | 20 | 8 | 3 |
| 15000 | 35 | 12 | 5 |
| 50000 | 80 | 20 | 10 |
| 150000 | 120 | 25 | 15 |
| 450000 | 150 | 35 | 20 |
| 1000000 | 200 | 50 | 25 |
| 3000000 | 300 | 70 | 35 |
```

--------------------------------

### Download Newly Registered Domains (CSV)

Source: https://whoisfreaks.com/products/newly-registered-domains

Allows downloading newly registered domain data in CSV format. Requires specifying the domain type (gTLD or ccTLD) and includes parameters for API key, date, and WHOIS data retrieval.

```APIDOC
Endpoint:
  /download/domainer/{gtld|cctld}

Description:
  Downloads newly registered domain data in CSV format.

Parameters:
  apiKey (Required): Your API key.
  whois (Required, boolean): Set to 'false' for standard CSV download. If true, it retrieves a CSV file containing newly registered domains for gTLDs and ccTLDs.
  date (Optional, string): Date parameter in yyyy-MM-dd format. Fetches most recent data if omitted.

Example Request (gTLD):
  GET https://files.whoisfreaks.com/v3.1/download/domainer/gtld?apiKey=API_KEY&whois=false&date=

Example Request (ccTLD):
  GET https://files.whoisfreaks.com/v3.1/download/domainer/cctld?apiKey=API_KEY&whois=false&date=
```

```Shell
GET https://files.whoisfreaks.com/v3.1/download/domainer/gtld?apiKey=API_KEY&whois=false&date=
```

```Shell
GET https://files.whoisfreaks.com/v3.1/download/domainer/cctld?apiKey=API_KEY&whois=false&date=
```

--------------------------------

### DNS Database Download Information

Source: https://whoisfreaks.com/products/dns-database

Details on accessing and downloading DNS database updates, including file formats and availability.

```text
DNS database downloads enable bulk data analysis, network monitoring, threat intelligence, compliance audits, SEO optimization, email server tuning, disaster recovery, and domain transfers.

Access database updates files in our billing dashboard to download daily CSV database updates from the past three months. Weekly and monthly updates are also available. Download a sample file of daily updates in zipped CSV format for quick and convenient access.
```

--------------------------------

### Whoisfreaks Product API List

Source: https://whoisfreaks.com/products/newly-registered-domains

A comprehensive list of APIs offered by Whoisfreaks for various domain and security-related services. Each API serves a specific lookup or monitoring purpose.

```APIDOC
Available APIs:

- Whois API: For live lookups, IP lookups, and ASN lookups.
  - Documentation: /products/whois-api#live_lookup, #ip_lookup, #asn_lookup

- Domain Availability API: For checking domain name availability.
  - Documentation: /products/domain-availability-api#domain_availability_lookup

- SSL Certificate Lookup API: For SSL certificate information.
  - Documentation: /products/ssl-certificate-api#ssl_live_lookup

- DNS API: For DNS record lookups.
  - Documentation: /products/dns-checker-api#live_dns_lookup

- Subdomains Lookup API: For finding subdomains.
  - Documentation: /products/subdomains-api#subdomains_lookup_api

- Security Lookup API: For security-related information.
  - Documentation: /products/security-api#security_lookup

- IP Geolocation Lookup API: For IP address geolocation.
  - Documentation: /products/ip-geolocation-api#geolocation_lookup

- Newly Registered Domains: For accessing lists of recently registered domains.
  - Documentation: /products/newly-registered-domains#with_whois

- Expiring & Dropped Domains: For lists of expiring or dropped domains.
  - Documentation: /products/expiring-dropped-domains#expiring_with_whois

- Whois Database: Access to a comprehensive Whois database.
  - Documentation: /products/whois-database#whois_database

- DNS Database: Access to a DNS database.
  - Documentation: /products/dns-database#dns_database

- Domain Monitoring: Service for monitoring domain status.
  - Documentation: /products/domain-monitoring

- Brand Monitoring: Service for monitoring brands.
  - Documentation: /products/brand-monitoring

- Registrant Monitoring: Service for monitoring domain registrants.
  - Documentation: /products/registrant-monitoring
```

--------------------------------

### DNS API Documentation

Source: https://whoisfreaks.com/products/whois-database/updates

Fetches DNS records for a given domain, including A, MX, NS, TXT, and CNAME records. Crucial for network diagnostics, domain configuration verification, and understanding domain infrastructure.

```APIDOC
DNS API:
  live_dns_lookup(domain: str, record_type: str = None)
    - Retrieves DNS records for a specified domain.
    - Parameters:
      - domain: The domain name to query (e.g., 'google.com').
      - record_type: Optional. The type of DNS record to retrieve (e.g., 'A', 'MX', 'TXT'). If not specified, all common record types are returned.
    - Returns: A list of DNS records matching the domain and record type.
```

--------------------------------

### SSL Certificate Lookup API Documentation

Source: https://whoisfreaks.com/products/brand-monitoring

Details on the SSL Certificate Lookup API, used for retrieving information about SSL certificates. Includes documentation for live SSL lookups.

```APIDOC
SSL Certificate Lookup API:
  - Live SSL Lookup: /products/ssl-certificate-api#ssl_live_lookup
```

--------------------------------

### Registrant Monitoring Documentation

Source: https://whoisfreaks.com/products/brand-monitoring

Information on the Registrant Monitoring product, which allows users to monitor domain registrations made by specific registrants.

```APIDOC
Registrant Monitoring:
  - Product Page: /products/registrant-monitoring
```

--------------------------------

### API Pricing and Rate Limits

Source: https://whoisfreaks.com/products/ssl-certificate-api

Details the different API subscription plans, including the number of credits and the corresponding requests per minute (RPM) limits for live, bulk, and historical/reverse lookups. Exceeding these limits will result in an HTTP 429 error.

```APIDOC
API Plans and Rate Limits:

Plan Details:
- Live-rpm: API requests per minute limit for live Whois lookup, domain availability, SSL certificate lookup, and DNS lookup API endpoints.
- Bulk-rpm: API requests per minute limit for bulk domain Whois lookup API endpoint.
- Historical/Reverse-rpm: API requests per minute limit for historical, and reverse Whois API endpoints.

Error Condition:
- Exceeding request per minute limits will result in an HTTP error code of 429.

Pricing Tiers:

| Credits   | Live-rpm | Bulk-rpm | Historical/Reverse-rpm |
|-----------|----------|----------|------------------------|
| 5000      | 20       | 8        | 3                      |
| 15000     | 35       | 12       | 5                      |
| 50000     | 80       | 20       | 10                     |
| 150000    | 120      | 25       | 15                     |
| 450000    | 150      | 35       | 20                     |
| 1000000   | 200      | 50       | 25                     |
| 3000000   | 300      | 70       | 35                     |
```

--------------------------------

### API Rate Limits by Subscription (Per Minute)

Source: https://whoisfreaks.com/products/dns-checker-api

Defines the request per minute (rpm) limits for various API subscription plans based on credit tiers. This table specifies limits for Live, Bulk, and Historical/Reverse API endpoints.

```APIDOC
API Subscription Rate Limits:

| Credits | Live-rpm | Bulk-rpm | Historical/Reverse-rpm |
| --- | --- | --- | --- |
| 5000 | 20 | 8 | 3 |
| 15000 | 35 | 12 | 5 |
| 50000 | 80 | 20 | 10 |
| 150000 | 120 | 25 | 15 |
| 450000 | 150 | 35 | 20 |
| 1000000 | 200 | 50 | 25 |
| 3000000 | 300 | 70 | 35 |
```

--------------------------------

### Newly Registered Domains API Documentation

Source: https://whoisfreaks.com/products/whois-database/updates

Tracks newly registered domain names, providing insights into emerging trends, competitor activities, and potential cybersquatting or phishing attempts. Includes WHOIS data for newly registered domains.

```APIDOC
Newly Registered Domains API:
  with_whois(date: str = None, limit: int = 100)
    - Retrieves a list of newly registered domains, optionally filtered by date, with associated WHOIS data.
    - Parameters:
      - date: Optional. The specific date to retrieve records for (e.g., 'YYYY-MM-DD'). Defaults to the current day if not provided.
      - limit: Optional. The maximum number of records to return (default: 100).
    - Returns: A list of newly registered domains with their respective WHOIS details.
```

--------------------------------

### Domain Availability API (POST)

Source: https://whoisfreaks.com/products/domain-availability-api

Checks the availability of multiple domains in bulk or checks availability for specific TLDs. Requires an API key and a request body. Supports JSON and XML output formats.

```APIDOC
API Endpoint: POST https://api.whoisfreaks.com/v1.0/domain/availability

Description:
Performs bulk domain availability checks. Can check a list of domain names or a list of TLDs for a given domain.

Query Parameters:
* Required:
  - apiKey (string): Your API key obtained from the billing dashboard.
* Optional:
  - format (string): The desired response format. Available values: JSON, XML. Defaults to JSON.

Request Body:
Must contain either 'domainNames' or 'tld'.
- domainNames (array of strings): A list of domain names to check availability for.
- tld (array of strings): A list of TLDs to check availability for a base domain (used for bulk availability with custom TLDs).

Responses:
- 200 OK: Successful request.
- 206 Partial Content: Partial response, potentially due to limits or errors.
- 400 Bad Request: Missing required 'domainNames' or 'tld' in the request body.
- 401 Unauthorized: Invalid, inactive, or expired API key, or insufficient subscription/credits.
- 403 Forbidden: Unavailable domain extension or domain belongs to an inactive TLD.
- 412 Precondition Failed: Exceeded API plan request limit.
- 413 Payload Too Large: Exceeded maximum list size (100) or API credit requests limit.
- 429 Too Many Requests: Maximum request limit reached.
- 500 Internal Server Error: Server encountered an error.
- 503 Service Unavailable: The service is temporarily unavailable.
- 504 Gateway Timeout: Request timed out.

Example Usage:
POST https://api.whoisfreaks.com/v1.0/domain/availability?apiKey=YOUR_API_KEY
Body:
{
    "domainNames":[
        "jfreaks.pk",
        "whoisfreaks.com"
    ]
}

POST https://api.whoisfreaks.com/v1.0/domain/availability?apiKey=YOUR_API_KEY
Body:
{
    "tld":[
        "com",
        "pk"
    ]
}
```

--------------------------------

### Subdomains Lookup API Documentation

Source: https://whoisfreaks.com/products/brand-monitoring

Documentation for the Subdomains Lookup API, designed to find subdomains associated with a given domain. It details the subdomain lookup process.

```APIDOC
Subdomains Lookup API:
  - Subdomains Lookup API: /products/subdomains-api#subdomains_lookup_api
```

--------------------------------

### Whois Files Status API - Query Parameters and Responses

Source: https://whoisfreaks.com/products/newly-registered-domains

Details the query parameters and HTTP response codes for the Whois Files Status API. It specifies required and optional parameters like apiKey and date, and lists common status codes with their meanings.

```APIDOC
API Endpoint: Files Status API

Query Parameters:
  * apiKey (Required): Your API key obtained from the billing dashboard.
  * date (Optional): Date parameter in 'yyyy-MM-dd' format. Fetches most recent data if not specified.

Responses:
  200 OK: Successful request.
  400 Bad Request: Provided date is too old.
  401 Unauthorized:
    - Api record not found.
    - Provided API key is inactive.
    - Please buy domainer package.
    - Your domainer package plan is inactive.
    - You cannot download file.
    - You have exceeded the download limit of 20000.
    - Suspicious Activity.
  404 Not Found:
    - File is not available of this date.
    - Resources are not available of this date.
  413 Payload Too Large: Please upgrade your plans.
```

--------------------------------

### Security Lookup API Documentation

Source: https://whoisfreaks.com/products/brand-monitoring

Provides documentation for the Security Lookup API, which offers insights into various security-related aspects of domains and IPs. Covers security lookups.

```APIDOC
Security Lookup API:
  - Security Lookup: /products/security-api#security_lookup
```

--------------------------------

### Domain Availability API Features

Source: https://whoisfreaks.com/products/domain-availability-api

Details on how to use the Domain Availability API for domain suggestions and bulk checks. The API supports fetching up to 100 domain suggestions by signing in and setting the 'suggestion' parameter to true. It also allows for efficient bulk domain availability checks.

```APIDOC
Domain Availability API:

Features:
  - Domain Suggestions:
    - Default: 5 suggestions.
    - Max: Up to 100 suggestions by signing in and setting 'suggestion' to true.
  - Bulk Domain Name Search:
    - Check availability of multiple domains efficiently.
  - Real-time data:
    - Ensures queries are accurate and relevant with the most current domain data.
  - Supported formats:
    - JSON
    - XML
```

--------------------------------

### Download gTLD Newly Registered Domains CSV

Source: https://whoisfreaks.com/products/newly-registered-domains

API endpoint to download a CSV file of newly registered gTLDs, without full WHOIS details. Requires an API key.

```APIDOC
API GET CSV Format
https://files.whoisfreaks.com/v3.1/download/domainer/gtld?apiKey=API_KEY&whois=false&date=YYYY-MM-DD

Query Parameters:
  apiKey (Required): Your API key obtained from the billing dashboard.
  whois (Required, boolean): Set to 'false' to exclude full WHOIS information.
  date (Optional, yyyy-MM-dd): Filter results by date. If omitted, the most recent data is fetched.

Responses:
  200 OK: CSV file downloaded successfully.
  400 Provided date is too old.
  401 Api record not found.
  401 Provided API key is inactive.
  401 Please buy domainer package.
  401 Your domainer package plan is inactive.
  401 You cannot download file.
  401 You have exceeded the download limit of 20000.
  401 Suspicious Activity.
  404 File is not available of this date.
  404 Resources are not available of this date.
  413 Please upgrade your plans.
```

```Shell
GET https://files.whoisfreaks.com/v3.1/download/domainer/gtld?apiKey=YOUR_API_KEY&whois=false&date=2023-10-27
```

--------------------------------

### Security API Bulk IP Lookup and Rate Limiting

Source: https://whoisfreaks.com/products/security-api

Explains the support for bulk IP lookups and outlines the rate limiting policies for free and paid API plans, including specific limits for different endpoint types.

```APIDOC
Bulk IP Lookup:
  Supported: Yes, up to 100 IP addresses per request.

Rate Limiting:
  Free Plan:
    - Live APIs: 10 requests per minute (rpm).
    - Bulk Domain Lookup: 5 rpm.
    - Reverse/Historical Endpoints: 1 rpm.

  Paid Plans:
    - Rate limiting applies to all paid plans.
    - Limits are based on plan tiers (Credits).
    - Error on Exceeding Limit: HTTP error code 429.

  Rate Limit Definitions:
    - Live-rpm: Requests per minute for live Whois, domain availability, SSL certificate, and DNS lookup endpoints.
    - Bulk-rpm: Requests per minute for bulk domain Whois lookup endpoint.
    - Historical/Reverse-rpm: Requests per minute for historical and reverse Whois API endpoints.

  Plan Tiers (Example - Credits vs. RPM):
    | Credits   | Live-rpm | Bulk-rpm | Historical/Reverse-rpm |
    |-----------|----------|----------|------------------------|
    | 5000      | 20       | 8        | 3                      |
    | 15000     | 35       | 12       | 5                      |
    | 50000     | 80       | 20       | 10                     |
    | 150000    | 120      | 25       | 15                     |
    | 450000    | 150      | 35       | 20                     |
    | 1000000   | 200      | 50       | 25                     |
    | 3000000   | 300      | 70       | 35                     |
```

--------------------------------

### Newly Registered Domains File Generation Times

Source: https://whoisfreaks.com/products/newly-registered-domains

Details the scheduled times for generating and making available whois files for newly registered domains. Files are updated daily based on their Top-Level Domain (TLD) type.

```APIDOC
File Generation Schedule:

1. ccTLD Files:
   - Availability: 23:55 UTC daily
   - Data reflects: The current day's registrations

2. gTLD Files:
   - Availability: 13:30 UTC daily
   - Data reflects: The current day's registrations

3. DNS Files:
   - Availability: 02:00 UTC daily
   - Data reflects: The previous day's data
```