Skip to main content

domainkits

Python client for the DomainKits REST API.

This is the official Python SDK for the DomainKits API, published and maintained by the DomainKits team. DomainKits is built and operated by Lyalpha GmbH, with domain data and infrastructure provided by ABTdomain, our domain intelligence and data aggregation platform. This repository is hosted under the ABTdomain GitHub organisation. Learn more about the relationship at domainkits.com/about.

Every parameter, response field and current limit is documented in the API reference and the OpenAPI spec. This README only lists what the SDK covers. No dependencies outside the standard library.

Requirements

The REST API is for Premium and Platinum accounts; unauthenticated requests are rejected with 401. Keys start with dk_ and come from domainkits.com.

Install

pip install domainkits

Usage

import os
from domainkits import DomainKits

dk = DomainKits(os.environ["DOMAINKITS_API_KEY"])

result = dk.nrds.list(query="shop", tld="com")
print(result["total"], "matches")

Parameters are passed as keyword arguments using the REST parameter names, verbatim.

Endpoints

Search resources, each with list, paginate and export:

Resource Endpoint
dk.expired /search/expired
dk.nrds /search/nrds
dk.aged /search/aged
dk.active /search/active
dk.deleted /search/deleted
dk.market /search/market

Lookups and reports:

Method Endpoint
dk.whois(domain) /whois
dk.dns(domain) /dns
dk.bulk_dns(domains) /bulk/dns
dk.bulk_whois(domains) /bulk/whois
dk.ip_lookup(query) /ip-lookup
dk.registrar(query) /registrar
dk.status_guide(query) /status-guide
dk.tld_check(prefix) /tld-check
dk.typosquat(domain) /typosquat
dk.ns_reverse(ns) /ns-reverse
dk.monitor_changes() /monitor/changes
dk.hostname_search(q) /search/hostname
dk.ct_subdomains(domain) /ct/subdomains
dk.ct_certs() /ct/certs
dk.tld_trends(type) /trends/tlds/*
dk.keyword_trends(type) /trends/keywords/*
dk.nrds_download() /nrds/download
dk.usage() /usage
dk.search_status() /search/status
dk.health() /health

The API reference is the authority on every filter, field and limit.

No PII. Responses contain no registrant personal data.

Errors

from domainkits import DomainKits, RateLimitError, AuthError, DomainKitsError

try:
    dk.whois("example.com")
except RateLimitError as err:
    print("retry after", err.retry_after_ms, "ms")
except AuthError as err:
    print("key rejected:", err)
except DomainKitsError as err:
    print(err.status, err)

RateLimitError (429) carries the rate-limit headers and a retry_after_ms; the client retries 429 and 5xx responses on its own up to max_retries before raising.

Options

dk = DomainKits(
    "dk_...",
    base_url="https://premium-api.domainkits.com/api/v1",
    timeout=60.0,
    max_retries=2,
)

Resources

License

MIT

Metadata

Release files for domainkits 0.4.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for domainkits 0.4.2
File Size Uploaded
domainkits-0.4.2.tar.gz 7.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for domainkits 0.4.2
File Interpreter ABI Platform
domainkits-0.4.2-py3-none-any.whl Python 3 none any Details

Total release size: 14.3 kB

Release files / domainkits-0.4.2.tar.gz

Download URL domainkits-0.4.2.tar.gz
Size 7.0 kB
Tags Source
SHA-256 checksum
How to use checksums
c3aa1711c2b21927b5cbdb5644f6f43fb1a629ca403712fccf8922bca9c48201
BLAKE2b-256 checksum
How to use checksums
475c0e896d37ac295638b1411bceb787bd29bfb4f940286cabf493e2eb3d8eb7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release files / domainkits-0.4.2-py3-none-any.whl

Download URL domainkits-0.4.2-py3-none-any.whl
Size 7.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
956dcb86d4944e8254af170cf900afecfdd825c39559fac6dc08b9425b72282f
BLAKE2b-256 checksum
How to use checksums
749c8bfcdd7b6b71a9b9ea0b3e75ce668cc4b1d01165bd58732be1f0ce40da04
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

0.4.2 This release

2 release files

0.4.1

2 release files

0.3.9

2 release files

0.3.8

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page