Overview
The client library for
Brand Alert 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/brand-alert-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 := brandalert.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 := brandalert.NewClient(apiKey, brandalert.ClientParams{
HTTPClient: &http.Client{
Transport: transport,
Timeout: 20 * time.Second,
},
})
Make basic requests
Brand Alert API searches across all recently registered & deleted domain names and returns result sets consisting of domain names that contain term(s) that are specified by you.
brandAlertResp, resp, err := client.Purchase(ctx,
&brandalert.SearchTerms{"google"}
nil)
for _, obj := range brandAlertResp.DomainsList {
log.Println(obj.DomainName)
}
domainsCount, _, err := client.Preview(ctx,
&brandalert.SearchTerms{"google"},
nil)
log.Println(domainsCount)
resp, err := client.RawData(ctx,
&brandalert.SearchTerms{"google", "blog"},
&brandalert.SearchTerms{"analytics"},
brandalert.OptionResponseFormat("XML"))
log.Println(string(resp.Body))