https://github.com/whois-api-llc/whois-api-go
Whois API client library for Go
https://github.com/whois-api-llc/whois-api-go
go golang whois whois-client whois-lookup whoisxmlapi
Last synced: about 1 month ago
JSON representation
Whois API client library for Go
- Host: GitHub
- URL: https://github.com/whois-api-llc/whois-api-go
- Owner: whois-api-llc
- License: mit
- Created: 2022-05-02T13:59:32.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-05-02T14:09:05.000Z (almost 3 years ago)
- Last Synced: 2025-01-25T21:27:59.374Z (3 months ago)
- Topics: go, golang, whois, whois-client, whois-lookup, whoisxmlapi
- Language: Go
- Homepage: https://whois.whoisxmlapi.com
- Size: 11.7 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://opensource.org/licenses/MIT)
[](https://pkg.go.dev/github.com/whois-api-llc/whois-api-go)
[](https://github.com/whois-api-llc/whois-api-go/actions/)
# Overview
The client library for
[Whois API](https://whois.whoisxmlapi.com/)
in Go language.
The minimum go version is 1.17.
# Installation
The library is distributed as a Go module
```bash
go get github.com/whois-api-llc/whois-api-go
```
# Examples
Full API documentation available [here](https://whois.whoisxmlapi.com/documentation/making-requests)
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](https://whoisxmlapi.com/).
Using the API Key you can create Client.
Most users will be fine with `NewBasicClient` function.
```go
client := whoisxmlapigo.NewBasicClient(apikey)
```
If you want to set custom `http.Client` to use proxy then you can use `NewClient` function.
```go
transport := &http.Transport{Proxy: http.ProxyURL(proxyUrl)}
client := whoisxmlapigo.NewClient(apiKey, whoisxmlapigo.ClientParams{
HTTPClient: &http.Client{
Transport: transport,
Timeout: 20 * time.Second,
},
})
```
## Make basic requests
Whois API provides the registration details of a domain name.
```go
// Make request to get WHOIS record for domain
rec, _, err := client.WhoisService.Data(ctx, "whoisxmlapi.com")
if err != nil {
log.Fatal(err)
}
log.Println(rec.DomainName, rec.Audit.UpdatedDate)
// Make request to get raw WHOIS API data
resp, err := client.WhoisService.RawData(ctx, "whoisxmlapi.com")
if err != nil {
log.Fatal(err)
}
log.Println(string(resp.Body))
```