ipapicom

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient() Client
  • func NewClientWithAPIKey(apiKey string) Client
• type Location

Constants

const ProURL = "https://pro.ip-api.com"

Pro URL.

const StandardURL = "http://ip-api.com"

Primary URL.

Variables

var (
	ErrReservedRange = errors.New("reserved range")
	ErrPrivateRange  = errors.New("private range")
)

Types

type Client

type Client interface {
	GetLocationForIP(ctx context.Context, ip string) (*Location, error)
}

func NewClient

func NewClient() Client

func NewClientWithAPIKey

func NewClientWithAPIKey(apiKey string) Client

type Location

type Location struct {
	As          string  `json:"as"`
	City        string  `json:"city"`
	Country     string  `json:"country"`
	CountryCode string  `json:"countryCode"`
	Isp         string  `json:"isp"`
	Lat         float32 `json:"lat"`
	Lon         float32 `json:"lon"`
	Message     string  `json:"message"`
	Org         string  `json:"org"`
	Query       string  `json:"query"`
	Region      string  `json:"region"`
	RegionName  string  `json:"regionName"`
	Status      string  `json:"status"`
	Timezone    string  `json:"timezone"`
	Zip         string  `json:"zip"`
}

Location contains all the relevant data for an IP.