ipwhois

README

IP Whois Go Client

This is an unofficial client for the IPWhois.io API.

Quick Start

Install and Use in Command Line:

go install github.com/lafronzt/ipwhois/cmd/ipwhois@latest

ipwhois -ip 1.1.1.1

Us as a Go Package

package main

imports (
    "fmt"
    "github.com/lafronzt/ipwhois"
)

var c *ipwhois.Client

func init() {

   c = ipwhois.NewClient()

}

func main() {

    ip := "1.1.1.1"

    whois, err := c.GetIPDetails(IP, nil)
    if err != nil {
      println(err.Error())
      return
    }

    fmt.Printf("%+v\n", whois)
}

To Use with the Pro Version of IPWhois.io use the following

ipwhois.NewClientPro("api-key")

Requirements

• Go >= 1.15

Documentation

Index

• Variables
• type Client
  • func NewClient() *Client
  • func NewClientPro(apiKey string) *Client
  • func (c *Client) GetIPDetails(ip *string, opts *Options) (*IPDetails, error)
• type IPDetails
• type Options

Variables

var (
	// Base URL for the whois API
	FreeURL = "http://ipwhois.app/json/"  // FreeURL is the URL of the Free API Serivice, exported so it can be changed if needed.
	ProURL  = "https://ipwhois.pro/json/" // ProURL is the URL of the Pro (Paid) API Serivice, exported so it can be changed if needed
)

Types

type Client

type Client struct {
	HTTPClient *http.Client // HTTP client for API requests.
	// contains filtered or unexported fields
}

Client is the client for the ipwhois API

func NewClient

func NewClient() *Client

NewClient returns a new Client for the Free Version of the API.

func NewClientPro

func NewClientPro(apiKey string) *Client

NewClientPro returns a new Client for the Pro Version of the API. You must provide your API key for the Pro Version.

func (*Client) GetIPDetails

func (c *Client) GetIPDetails(ip *string, opts *Options) (*IPDetails, error)

GetIPDetails returns the details for an IP address. See https://ipwhois.io/documentation for more information. It returns a pointer to the IPDetails struct.

type IPDetails

type IPDetails struct {
	IP                string  `json:"ip,omitempty"`                 // IP address used for the query
	Success           bool    `json:"success,omitempty"`            // Indicates if the query was successful. true or false
	Message           string  `json:"message,omitempty"`            // Error message if the query was not successful
	Type              string  `json:"type,omitempty"`               // The type of the query. IPv4 or IPv6
	Continent         string  `json:"continent,omitempty"`          // The continent of the IP address. I.e North America
	ContinentCode     string  `json:"continent_code,omitempty"`     // The continent code of the IP address. I.e NA
	Country           string  `json:"country,omitempty"`            // The country of the IP address. I.e United States
	CountryCode       string  `json:"country_code,omitempty"`       // The country code of the IP address. I.e US
	CountryFlag       string  `json:"country_flag,omitempty"`       // URL to an image of the country's flag.
	CountryCapital    string  `json:"country_capital,omitempty"`    // The capital city of the country. I.e Washington
	CountryPhone      string  `json:"country_phone,omitempty"`      // The country's phone code. I.e +1
	CountryNeighbours string  `json:"country_neighbours,omitempty"` // The country's neighbours. I.e CA, MX
	Region            string  `json:"region,omitempty"`             // The region/state of the IP address. I.e Virginia
	City              string  `json:"city,omitempty"`               // The city of the IP address. I.e Ashburn
	Latitude          float64 `json:"latitude,omitempty"`           // The latitude of the IP address. I.e 39.0437567
	Longitude         float64 `json:"longitude,omitempty"`          // The longitude of the IP address. I.e -77.4874416
	Asn               string  `json:"asn,omitempty"`                // The Autonomous System Number of the IP address. I.e AS15169
	Org               string  `json:"org,omitempty"`                // The organization of the IP address. I.e Google, Inc.
	Isp               string  `json:"isp,omitempty"`                // The ISP of the IP address. I.e Comcast Cable Communications, Inc.
	Timezone          string  `json:"timezone,omitempty"`           // The timezone of the IP address's Host Location. I.e America/New_York
	TimezoneName      string  `json:"timezone_name,omitempty"`      // The timezone name of the IP address's Host Location. I.e Eastern Stanard Time
	TimezoneDstOffset float64 `json:"timezone_dstOffset,omitempty"` // The timezone DST offset of the IP address's Host Location. I.e 0
	TimezoneGmtOffset float64 `json:"timezone_gmtOffset,omitempty"` // The timezone GMT offset of the IP address's Host Location. I.e -18000
	TimezoneGmt       string  `json:"timezone_gmt,omitempty"`       // The timezone GMT of the IP address's Host Location. I.e GMT -5:00
	Currency          string  `json:"currency,omitempty"`           // The currency of the IP address's Host Country. I.e US Dollar
	CurrencyCode      string  `json:"currency_code,omitempty"`      // The currency code of the IP address's Host Country. I.e USD
	CurrencySymbol    string  `json:"currency_symbol,omitempty"`    // The currency symbol of the IP address's Host Country. I.e $
	CurrencyRates     float64 `json:"currency_rates,omitempty"`     // The current exchange rate against the US dollar. I.e 1
	CurrencyPlural    string  `json:"currency_plural,omitempty"`    // The currency plural of the IP address. I.e US Dollars
	CompletedRequests int     `json:"completed_requests,omitempty"` // Number of API calls for the current month (Updated every 2 minutes).
}

IPDetails is the struct for the details of an IP address. See https://ipwhois.io/documentation for more information.

type Options

type Options struct {
	Objects  []string `url:"objects,comma"` // Objects is a list of objects to get details for. I.e ["country","city","timezone"] this would only return those fields. It is recommended to always add "success" and "message" when filtering so these messages are returned as well
	Language string   `url:"lang"`          // Language localizes city, region, country and continent names. Defaults to English. Other Options: "en", "ru", "de", "es", "pt-br", "fr", "zh-cn", "ja"
}

Options represents the options for the GetIPDetails request.