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.nrds_live /search/nrds-live
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.safety(domain) /safety
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.ct_subdomains(domain) /ct/subdomains
dk.ct_certs() /ct/certs
dk.ct_search(keyword) /ct/search
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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

domainkits-0.3.8.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

domainkits-0.3.8-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file domainkits-0.3.8.tar.gz.

File metadata

  • Download URL: domainkits-0.3.8.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for domainkits-0.3.8.tar.gz
Algorithm Hash digest
SHA256 1024a81385d2eae7623b48969ad236cbab285279e7d21090fb47c77d347ab909
MD5 3b56dabfefa9958893a2b02ac70e968e
BLAKE2b-256 00e792c20f864243f5d7bb45442736331e4d137da10298eeb77c890a5ca15660

See more details on using hashes here.

File details

Details for the file domainkits-0.3.8-py3-none-any.whl.

File metadata

  • Download URL: domainkits-0.3.8-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for domainkits-0.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 d9e1027e1b55f6a82dbcfbb73dc8b07862c4a149c19a20155e6e306e517326fb
MD5 17bbd0968decd8237c613ae2be255d9b
BLAKE2b-256 84c6c31bcd35cacd8d0fa887a4fce11fd5a0401de38dedab0d6cab162c914549

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.3.8 This release

2 files

0.1.1

2 files

0.1.0

2 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