1. Home
2. Reference documentation
3. VCL Reference
4. Variables

Geolocation

• client.as.name
• client.as.number
• client.geo.area_code
• client.geo.city
• client.geo.city.ascii
• client.geo.city.latin1
• client.geo.city.utf8
• client.geo.conn_speed
• client.geo.conn_type
• client.geo.continent_code
• client.geo.country_code
• client.geo.country_code3
• client.geo.country_name
• client.geo.country_name.ascii
• client.geo.country_name.latin1
• client.geo.country_name.utf8
• client.geo.gmt_offset
• client.geo.ip_override
• client.geo.latitude
• client.geo.longitude
• client.geo.metro_code
• client.geo.postal_code
• client.geo.proxy_description
• client.geo.proxy_type
• client.geo.region
• client.geo.region.ascii
• client.geo.region.latin1
• client.geo.region.utf8
• client.geo.utc_offset
• geoip.area_code
• geoip.city
• geoip.city.ascii
• geoip.city.latin1
• geoip.city.utf8
• geoip.continent_code
• geoip.country_code
• geoip.country_code3
• geoip.country_name
• geoip.country_name.ascii
• geoip.country_name.latin1
• geoip.country_name.utf8
• geoip.ip_override
• geoip.latitude
• geoip.longitude
• geoip.metro_code
• geoip.postal_code
• geoip.region
• geoip.region.ascii
• geoip.region.latin1
• geoip.region.utf8
• geoip.use_x_forwarded_for

All geographic data presented through these variables is associated with a particular IP address. This address is automatically populated from client.ip by default, but may be overridden explicitly by setting client.geo.ip_override.

Geographic variables representing names are available in several encodings. Note in particular the *.ascii variables are lossy. These variables have diacritics removed and are normalized to lower case spellings. These *.ascii variables are intended for ease of use as a symbolic string in code (for example, to perform some different action depending on the city name), and are generally inappropriate for presenting to users due to their simplified content.

Absent data

The Geolocation data is updated periodically, as IP allocations change and various amendments are made. Some variables may be absent for the current data at any given time.

For STRING types, the special value ? is used to indicate absent data. These may be normalized to VCL empty strings using the if() ternary operator:

log if (client.as.name == "?", client.as.name, "");

In general strings in VCL may be not set (see the VCL documentation for types). This should never occur for the Geolocation variables.

Reserved IP address blocks

The IPv4 and IPv6 address spaces have several blocks reserved for special uses; these include private use networks (e.g. 192.168.0.0/16), loopback (127.0.0.1/8), and address ranges reserved for documentation (e.g. 203.0.113.0/24 RFC 5737 TEST-NET-3).

Geographic data has no meaningful association for these ranges, and so the Geolocation VCL variables present special values for these ranges instead. These values are: