CZDS API Client in Python

March 23, 2025 · View on GitHub

This repository provides a Python example of how to download zone files via CZDS (Centralized Zone Data Service) REST API. A detail API Specs can be found here.

There is also an example provided in Java. It can be found in this repo.

Installation

This script requires Python 3. It has been tested with Python 3.13.2

It requires the requests extension library. Please checkout here to see how to install it - https://github.com/requests/requests

Run

Make a copy of the config.sample.json file and name it config.json
Edit config.json and fill in your information.
Run python download.py

All the zone files will be saved in working-directory/zonefiles, working-directory is specified in config.json, or default to current directory if not specified in config.json

By default, it will download all the APPOVED zone files. If you only want a subset of the zone files, specify the tlds: [] in the config.json. Note: missing tlds or empty [] means downloadd all the APPROVED zone files.

Documentation

CZDS REST API Specs - https://github.com/icann/czds-api-client-java/blob/master/docs/ICANN_CZDS_api.pdf

Contributing

Contributions are welcome.

Other

Reference Implementation in Java: https://github.com/icann/czds-api-client-java