WhoisFreaks SDK Documentation

Official documentation for the WhoisFreaks SDKs — one API, 10 languages, 60 endpoints. Every SDK is generated from the same OpenAPI specification and published to its language's standard registry.

Complete WhoisFreaks API — WHOIS, DNS, SSL, Geolocation, Typosquatting, IP Intelligence, Domain Reputation, and bulk database downloads.

Contents

• Authentication — get and configure your API key
• Language guides — install + usage for each SDK
• Endpoint reference — all 60 endpoints, grouped by category
• Runnable examples — copy-paste, ready-to-run example for every endpoint in every language

Language guides

Language	Registry	Package	Guide
Python	PyPI	whoisfreaks	Guide
JavaScript	npm	whoisfreaks-js	Guide
TypeScript	npm	whoisfreaks	Guide
Java	Maven Central	com.whoisfreaks:whoisfreaks	Guide
Kotlin	Maven Central	com.whoisfreaks:whoisfreaks	Guide
C# / .NET	NuGet	WhoisFreaks	Guide
Ruby	RubyGems	whoisfreaks	Guide
Go	Go modules	github.com/WhoisFreaks/whoisfreaks-go	Guide
Swift	Swift PM	github.com/WhoisFreaks/whoisfreaks-swift	Guide
PHP	Packagist	WhoisFreaks/whoisfreaks-php	Guide

Quick start

Pick your language, install the package, set your API key, and call an endpoint. Example (Python):

pip install whoisfreaks

import whoisfreaks
from whoisfreaks import Configuration, ApiClient

config = Configuration()
config.api_key["ApiKeyAuth"] = "YOUR_API_KEY"
client = ApiClient(config)

result = client.whois_live(domainName="example.com")
print(result)

The equivalent for every other language is in its language guide.

Endpoint sections

The API is organized into three sections. See the full endpoint reference for every operation with parameters, response fields, and per-language examples.

API Solutions — 20 endpoints

Real-time and on-demand lookup APIs. Query a single domain, IP, or ASN and get structured JSON (or XML) back immediately.

WHOIS, DNS, Domain Availability, Typosquatting, SSL, Geolocation, Subdomains, IP Reputation, Domain Reputation, ASN WHOIS, IP WHOIS

Databases — 37 endpoints

Bulk data feeds and downloadable database snapshots for large-scale processing — newly registered, expiring/dropped, and full WHOIS/DNS/IP datasets.

Databases - Newly Registered, Databases - Expiring & Dropped, Databases - WHOIS, Databases - DNS, Databases - Subdomains, Databases - IP Geolocation, Databases - ASN WHOIS, Databases - IP WHOIS, Databases - IP Security, Databases - Threat Feed

Account & Utilities — 3 endpoints

Manage your account, monitor API usage and credits, and rotate your API key.

Account

Authentication at a glance

All requests require an apiKey query parameter. Get a key at https://billing.whoisfreaks.com, then configure it once via each SDK's configuration object — see Authentication.

Base URLs:

Purpose	URL
Live lookups	https://api.whoisfreaks.com
Database downloads	https://files.whoisfreaks.com

About these docs

These docs are generated from the OpenAPI spec by scripts/gen_docs.py, so they stay in sync with the API. To regenerate after a spec change:

python3 scripts/gen_docs.py path/to/whoisfreaks-openapi.yaml .

Support

• API docs: https://whoisfreaks.com/documentation
• Billing & keys: https://billing.whoisfreaks.com
• Email: support@whoisfreaks.com

License

MIT — see individual SDK repositories for details.