Using WhoisFreaks APIs with Python: A Practical Developer's Guide

The WhoisFreaks Python SDK offers developers a robust toolkit for integrating domain intelligence features into their apps. It provides access to both current and historical domain registration records, enabling tracking of ownership shifts and in-depth analysis of domain data. The SDK supports advanced querying using registrant details or related information and includes tools for checking domain availability and handling multiple domains efficiently.

It also streamlines operations like formatting WHOIS data, managing API communications, and applying filters for more precise results. With built-in authentication and flexible query options, the SDK delivers a smooth experience for developers creating tools for domain analysis, cybersecurity, or digital asset oversight.

Installation Steps:

• To proceed, Python and pip must be installed on your machine. If it's not already installed, click here to install Python.
To install the SDK, you can visit the official SDK project on PyPi. Alternatively, you may follow these recommended steps:
• Install the WhoisFreaks Python SDK with the following command:
  bash Copy

                              pip install whoisfreaks
                          

  Error
  If you face an error like:
  bash Copy

                              error: externally-managed-environment
  
  This environment is externally managed
  ╰─> To install Python packages system-wide, try apt install python3-xyz, where xyz is the package you are trying to install.
                          

  To safely install whoisfreaks python sdk
  Use a Virtual Environment
  This isolates your project and avoids interfering with system Python.
  bash Copy

                                  python3 -m venv venv
  source venv/bin/activate
  pip install whoisfreaks
                              

  That's it, WhoisFreaks' Python SDK is installed in your environment.
• Local Build via Source Code

  If you'd like to build it yourself, you can follow these steps:

  1. Clone the repository:
     bash Copy

                                         git clone https://github.com/WhoisFreaks/wf-python-sdk.git
                                     

  2. Navigate to the cloned directory:
     bash Copy

                                         cd wf-python-sdk
                                     

  3. Create a Virtual Environment (Recommended):
     bash Copy

                                         python3 -m venv virtual_env  # Replace 'virtual_env' with a name of your choice.
     source venv/bin/activate
                                     

  4. Build the project:
     bash Copy

                                         pip install -e .
                                     

     The -e means editable mode, so any changes you make to the local source files will immediately reflect when you import the package.
  5. Remember, if you're using a virtual environment, you need to run your .py files using the Python interpreter from that environment. For example:
     bash Copy

                                         /home/user_name/path_to_directory/virtual_environment_name/bin/python3 your_python_file.py
                                     

     Please update all path variables to reflect your specific setup—for example, replace user_name with your machine’s username, path_to_directory with your actual directory path, virtual_environment_name with the name of your virtual environment, and so on.

• Installing or Upgrading to a Specific Version

  To download a specific version, you can follow these steps:

  1. To Upgrade to the latest version:
     bash Copy

                                         pip install whoisfreaks --upgrade
                                     

  To install a specific version, first check all available versions if you’re unsure. Alternatively, you can visit the official SDK project history on PyPi.
  2. To list all available versions using command line execute the following command:
     bash Copy

                                         pip index versions whoisfreaks
                                     

  3. To install a specific version, use the following command:
     bash Copy

                                         pip install whoisfreaks==version_number # e.g., 0.0.45
                                     

  4. To uninstall the package, use the following command:
     bash Copy

                                         pip uninstall whoisfreaks
                                     

That's it! With the WhoisFreaks SDK now installed, you can follow the steps below to perform any type of lookup.

To perform specific lookups using the Python SDK, click on one of the related options below.