maxmind

Documentation

Index

• Constants
• func GetDataAsFormattedJSON(city *City, asn *ASN) (string, error)
• func GetDataAsJSON(city *City, asn *ASN) (string, error)
• func PrintASNDetails(asn *ASN)
• func PrintCityDetails(city *City)
• type ASN
  • func GetASNFromIP(ip netip.Addr, dbPath string, printInfo bool) (*ASN, error)
• type City
  • func GetCityFromIP(ip netip.Addr, dbPath string, printInfo bool) (*City, error)

Constants

const (
	MaxmindCityDBEnv = "MAXMIND_CITY_DB"
	MaxmindASNDBEnv  = "MAXMIND_ASN_DB"
)

Functions

func GetDataAsFormattedJSON

func GetDataAsFormattedJSON(city *City, asn *ASN) (string, error)

func GetDataAsJSON

func GetDataAsJSON(city *City, asn *ASN) (string, error)

func PrintASNDetails

func PrintASNDetails(asn *ASN)

func PrintCityDetails

func PrintCityDetails(city *City)

displayCityName returns the city name to display, which is the city name if it is available, otherwise it falls back to the locality name, and if that is not available it returns an empty string.

Types

type ASN

type ASN struct {
	AutonomousSystemNumber       uint   `maxminddb:"autonomous_system_number"`
	AutonomousSystemOrganization string `maxminddb:"autonomous_system_organization"`
}

func GetASNFromIP

func GetASNFromIP(ip netip.Addr, dbPath string, printInfo bool) (*ASN, error)

type City

type City struct {
	City struct {
		GeoNameID uint32            `maxminddb:"geoname_id"`
		Names     map[string]string `maxminddb:"names"`
	} `maxminddb:"city"`
	Continent struct {
		Code      string            `maxminddb:"code"`
		GeoNameID uint32            `maxminddb:"geoname_id"`
		Names     map[string]string `maxminddb:"names"`
	} `maxminddb:"continent"`
	Country struct {
		GeoNameID         uint32            `maxminddb:"geoname_id"`
		ISOCode           string            `maxminddb:"iso_code"`
		IsInEuropeanUnion bool              `maxminddb:"is_in_european_union"`
		Names             map[string]string `maxminddb:"names"`
	} `maxminddb:"country"`
	Location struct {
		AccuracyRadius uint16  `maxminddb:"accuracy_radius"`
		Latitude       float64 `maxminddb:"latitude"`
		Longitude      float64 `maxminddb:"longitude"`
		MetroCode      uint    `maxminddb:"metro_code"`
		TimeZone       string  `maxminddb:"time_zone"`
	} `maxminddb:"location"`
	Postal struct {
		Code string `maxminddb:"code"`
	} `maxminddb:"postal"`
	RegisteredCountry struct {
		GeoNameID         uint32            `maxminddb:"geoname_id"`
		ISOCode           string            `maxminddb:"iso_code"`
		IsInEuropeanUnion bool              `maxminddb:"is_in_european_union"`
		Names             map[string]string `maxminddb:"names"`
	} `maxminddb:"registered_country"`
	RepresentedCountry struct {
		GeoNameID         uint32            `maxminddb:"geoname_id"`
		ISOCode           string            `maxminddb:"iso_code"`
		IsInEuropeanUnion bool              `maxminddb:"is_in_european_union"`
		Names             map[string]string `maxminddb:"names"`
		Type              string            `maxminddb:"type"`
	} `maxminddb:"represented_country"`
	Subdivisions []struct {
		GeoNameID uint32            `maxminddb:"geoname_id"`
		ISOCode   string            `maxminddb:"iso_code"`
		Names     map[string]string `maxminddb:"names"`
	} `maxminddb:"subdivisions"`
}

func GetCityFromIP

func GetCityFromIP(ip netip.Addr, dbPath string, printInfo bool) (*City, error)

https://www.maxmind.com/en/geoip-databases