WhoisJSON Python API Docs | dltHub
Build a WhoisJSON-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
WhoisJSON is a unified domain intelligence REST API that provides WHOIS lookups, DNS resolution, SSL certificate checks, domain availability, subdomain discovery and reverse WHOIS via a single API token. The REST API base URL is https://whoisjson.com/api/v1 and All requests require an API token in the Authorization header (Authorization: TOKEN=YOUR_API_KEY)..
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading WhoisJSON data in under 10 minutes.
What data can I load from WhoisJSON?
Here are some of the endpoints you can load from WhoisJSON:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| whois | /whois?domain={domain} | GET | WHOIS parsed record for a domain (registrar, dates, nameservers, contacts, status) | |
| nslookup | /nslookup?domain={domain} | GET | records | DNS records (A, AAAA, MX, TXT, CNAME, NS, SOA) |
| domain_availability | /domain-availability?domain={domain} | GET | Real-time domain registration status (available/registered) | |
| ssl_cert_check | /ssl-cert-check?domain={domain} | GET | SSL/TLS certificate details and validity | |
| subdomains | /subdomains?domain={domain} | GET | subdomains | Discovered active subdomains with A/CNAME records |
| reverse_whois | /reverseWhois?ip={ip} | GET | domains | Reverse WHOIS: domains associated with an IP |
| monitoring | /monitoring | POST/GET | varies | Domain monitoring service (alerts for WHOIS/DNS/SSL changes) |
How do I authenticate with the WhoisJSON API?
Set the Authorization header to TOKEN=YOUR_API_KEY on every request. The response includes a Remaining-Requests header to monitor quota.
1. Get your credentials
- Sign up for a free account at whoisjson.com and log in.
- Open the dashboard; your API token is generated immediately.
- Copy the token and use it in requests via the Authorization header as
TOKEN=YOUR_API_KEY.
2. Add them to .dlt/secrets.toml
[sources.whois_json_source] api_key = "your_api_key_here"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI Workbench:
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
dlt ai toolkit rest-api-pipeline install
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the WhoisJSON API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
python whois_json_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline whois_json_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset whois_json_data The duckdb destination used duckdb:/whois_json.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline whois_json_pipeline show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads whois and nslookup from the WhoisJSON API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def whois_json_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://whoisjson.com/api/v1", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "whois", "endpoint": {"path": "whois?domain={domain}"}}, {"name": "nslookup", "endpoint": {"path": "nslookup?domain={domain}", "data_selector": "records"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="whois_json_pipeline", destination="duckdb", dataset_name="whois_json_data", ) load_info = pipeline.run(whois_json_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("whois_json_pipeline").dataset() sessions_df = data.whois.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM whois_json_data.whois LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("whois_json_pipeline").dataset() data.whois.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load WhoisJSON data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Troubleshooting
Authentication failures
Ensure Authorization header is present and formatted as TOKEN=YOUR_API_KEY. HTTP 401 indicates missing or invalid token; 403 may indicate account/email not validated.
Rate limits & quotas
Responses include Remaining-Requests header. Free plan: 1,000 requests/month (shared across endpoints) and typical rate limits (e.g. 20 req/min free); exceeding limits returns 429.
Cache & force refresh
Responses are cached (3‑hour TTL). Add _forceRefresh=1 (or force=1 per docs) to bypass cache (may cost extra credits). If stale data expected, use force refresh.
Common errors summary: 400 Bad Request for invalid params, 401 Unauthorized for auth issues, 403 Access Denied (e.g. unverified email), 429 Limit Exceeded, 500 Internal Server Error — retry later.
Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-runtime— Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for WhoisJSON?
Request dlt skills, commands, AGENT.md files, and AI-native context.