README.md

Overview

The client library for Domain Availability API in Go language.

The minimum go version is 1.17.

Installation

The library is distributed as a Go module

go get github.com/whois-api-llc/domain-availability-go

Examples

Full API documentation available here

You can find all examples in example directory.

Create a new client

To start making requests you need the API Key. You can find it on your profile page on whoisxmlapi.com. Using the API Key you can create Client.

Most users will be fine with NewBasicClient function.

client := domainavailability.NewBasicClient(apiKey)

If you want to set custom http.Client to use proxy then you can use NewClient function.

transport := &http.Transport{Proxy: http.ProxyURL(proxyUrl)}

client := domainavailability.NewClient(apiKey, domainavailability.ClientParams{
    HTTPClient: &http.Client{
        Transport: transport,
        Timeout:   20 * time.Second,
    },
})

Make basic requests

Domain Availability API lets you get the domain registration state.

// Make request to get the Domain Availability API response as a model instance.
domainAvailabilityResp, _, err := client.Get(ctx, "whoisxmlapi.com")
if err != nil {
    log.Fatal(err)
}

if domainAvailabilityResp.IsAvailable != nil {
    if *domainAvailabilityResp.IsAvailable {
        log.Println(domainAvailabilityResp.DomainName, "is available") 
    } else {
        log.Println(domainAvailabilityResp.DomainName, "is unavailable")
    }
}

// Make request to get raw data in XML.
resp, err := client.GetRaw(context.Background(), "whoisxmlapi.com",
    domainavailability.OptionOutputFormat("XML"))
if err != nil {
    log.Fatal(err)
}

log.Println(string(resp.Body))