Skip to main content

Domain Availability Checker is a simple tool for checking the availability of a domain. It returns if the domain is available or not.

Project description

Domain Availability API

Domain Availability Checker is a simple tool for checking the availability of a domain. It returns if the domain is available or not.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Domain Availability API


Installation

Using pip:

pip install apiverve-domainavailability

Using pip3:

pip3 install apiverve-domainavailability

Configuration

Before using the domainavailability API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_domainavailability.apiClient import DomainavailabilityAPIClient

# Initialize the client with your APIVerve API key
api = DomainavailabilityAPIClient("[YOUR_API_KEY]")

query = { "domain": "myspace.com" }

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Domain Availability API documentation is found here: https://docs.apiverve.com/ref/domainavailability. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_domainavailability.apiClient import DomainavailabilityAPIClient

# Initialize the client with your APIVerve API key
api = DomainavailabilityAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = { "domain": "myspace.com" }
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "domain": "myspace.com",
    "available": false,
    "owner": {
      "registrar": "GoDaddy.com, LLC"
    }
  }
}

Error Handling

The API client provides comprehensive error handling through the DomainavailabilityAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_domainavailability.apiClient import DomainavailabilityAPIClient, DomainavailabilityAPIClientError

api = DomainavailabilityAPIClient("[YOUR_API_KEY]")

query = { "domain": "myspace.com" }

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except DomainavailabilityAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_domainavailability.apiClient import DomainavailabilityAPIClient, DomainavailabilityAPIClientError

api = DomainavailabilityAPIClient("[YOUR_API_KEY]")

query = { "domain": "myspace.com" }

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except DomainavailabilityAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_domainavailability.apiClient import DomainavailabilityAPIClient, DomainavailabilityAPIClientError

query = { "domain": "myspace.com" }

# Using context manager ensures proper cleanup
with DomainavailabilityAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except DomainavailabilityAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_domainavailability.apiClient import DomainavailabilityAPIClient

# Enable debug mode
api = DomainavailabilityAPIClient("[YOUR_API_KEY]", debug=True)

query = { "domain": "myspace.com" }

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_domainavailability.apiClient import DomainavailabilityAPIClient

api = DomainavailabilityAPIClient("[YOUR_API_KEY]")

query = { "domain": "myspace.com" }

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

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

Source Distribution

apiverve_domainavailability-1.1.14.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

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

apiverve_domainavailability-1.1.14-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_domainavailability-1.1.14.tar.gz.

File metadata

File hashes

Hashes for apiverve_domainavailability-1.1.14.tar.gz
Algorithm Hash digest
SHA256 dc1d7485291ebbba6f81fb06ee5a6e3961aecff67b655386bce4414d88ac76f0
MD5 50dba79336bb94c945424d33fe739914
BLAKE2b-256 c131c6ca0f6d458905553e9c6ee2b0838341999e9604c4f91662021ec62d5511

See more details on using hashes here.

File details

Details for the file apiverve_domainavailability-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_domainavailability-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 eaff05876ca1a2b3e1d1d4c8f3bddc5d70451356188df86f3d9807171c073761
MD5 4a2ec3aebfba9d33550a453f68cf8f45
BLAKE2b-256 119a9ab981886b021d09ff1aa4ab5afc5fa7310006995039d0b71aa2da3cea1a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page