Overview

The client library for IP Geolocation 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/go-simple-geoip

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 := simplegeoip.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 := simplegeoip.NewClient(apiKey, simplegeoip.ClientParams{
    HTTPClient: &http.Client{
        Transport: transport,
        Timeout:   20 * time.Second,
    },
})

Make basic requests

IP Geolocation API lets you check geographical location by IP address, domain name or email address.

// Make request to get parsed IP Geolocation API response for the client's public IP address
geoipResp, resp, err := client.GeoipService.Get(ctx)
if err != nil {
    log.Fatal(err)
}

log.Println(geoipResp.IP)
log.Println(geoipResp.Location.Country)

// Make request to get raw IP Geolocation API data
resp, err := client.GeoipService.GetRaw(ctx)
if err != nil {
    log.Fatal(err)
}

log.Println(string(resp.Body))