WhoisFreaks Docs

WhoisFreaks SDK Documentation

Official documentation for the WhoisFreaks SDKs: one API, 10 languages, 94 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

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-kotlin 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 os
import whoisfreaks

config = whoisfreaks.Configuration()
config.api_key["ApiKeyAuth"] = os.environ["WHOISFREAKS_API_KEY"]

with whoisfreaks.ApiClient(config) as client:
    record = whoisfreaks.WHOISApi(client).whois_live("example.com")
    print(record.domain_registrar.registrar_name, record.expiry_date)

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 its URL, parameters, response fields and Python, TypeScript and Go examples. The language guides show every operation in all 10 languages.

API Solutions (26 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 (65 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, Databases - Streaming

Account & Utilities (3 endpoints)

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

Account

Authentication at a glance

Every request except the public database file status check needs 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, bulk lookups and account https://api.whoisfreaks.com
Database downloads, threat feeds and database file status 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 or an SDK release (SDK_VERSION sets the version in install lines):

SDK_VERSION=0.24.0 python3 scripts/gen_docs.py spec/whoisfreaks-openapi.yaml .

Support

License

MIT. See individual SDK repositories for details.