regionmap

Documentation

Overview

Package regionmap maps IP address location info to region names.

The region names are primarily determined based on the country, but also use state/province/region names for larger countries. The mapping is based on a combination of data from:

• RFC 1918 private IPv4 addresses (https://www.rfc-editor.org/rfc/rfc1918).
• RFC 4193 private IPv6 addresses (https://www.rfc-editor.org/rfc/rfc4193).
• UN M.49 (https://unstats.un.org/unsd/methodology/m49/overview/).
• US Census (https://www2.census.gov/geo/pdfs/maps-data/maps/reference/us_regdiv.pdf).
• Canada 3-region model (https://en.wikipedia.org/wiki/List_of_regions_of_Canada).
• IP2Location region names (https://www.ip2location.com/free/iso3166-2).

The current mapping was created on November 20, 2022.

Index

• func GetRegion(ip netip.Addr, r ip2x.Record) (string, error)

Functions

func GetRegion

func GetRegion(ip netip.Addr, r ip2x.Record) (string, error)

GetRegion gets the region name for the provided IP address and IP2Location record. The IP2Location record should have at least CountryShort and Region fields. If the location is unrecognized, a best-effort region and an error is returned.