The Lua database reader allows your Lua application to use the on-premise IPQS IP reputation database and make informed decisions about IP addresses.
Lua Database Reader
About the Lua Database Reader
Installation
The Lua database reader is available as a "rock" from LuaRocks. Run the following command:
luarocks install ipqs-db-reader
Usage
The following example shows how you can use the Lua database reader in your application to determine if an IP address is a proxy.
Due to the nature of IEEE-754 floating-point representation, floating-point values may display misleading precision. For example, 32.51, when converted to little endian hexadecimal representation, is: 0x3D0A0242, which, if interpreted literally, actually represents 32.509998321533 in Lua. Our Latitude and Longitude values should be interpreted as accurate to 2 (rounded) decimal places (e.g., string.format("%.2f", record:get("Latitude"))).
| Note: Each database only holds either IPv4 or IPv6 data. Therefore, you may need two instances of the reader available depending on your use case. |
Record Table Indices
See the table below for most files' boolean values and default columns. Your particular file may have columns in addition to the default columns. Arbitrary columns may be queried with the record:get("ColumnName") syntax. Speak with your IPQS representative if you have any questions about your flat file database.
| Field | Type | Description |
| record.is_proxy | boolean | Is this IP address suspected to be a proxy? (SOCKS, Elite, Anonymous, VPN, Tor, etc.) |
| record.is_vpn | boolean | Is this IP suspected of being a VPN connection? This can include data center ranges which can become active VPNs at any time. The "proxy" status will always be true when this value is true. |
| record.is_tor | boolean | Is this IP suspected of being a TOR connection? This can include previously active TOR nodes and exits which can become active TOR exits at any time. The "proxy" status will always be true when this value is true. |
| record.is_crawler | boolean | Is this IP associated with a confirmed crawler from any of the following search engines: Baidu, Google, Bing, Yahoo, Yandex, Sogou, Exabot, DuckDuckGo, Facebook, Twitter, Pinterest, Naver, UptimeRobot, AppleBot, ArchiveBot, CoccocBot, YisouBot, PetalBot, ByteDance, or MailRU. |
| record.is_bot | boolean | Indicates if bots or non-human traffic has recently used this IP address to engage in automated fraudulent behavior. Provides stronger confidence that the IP address is suspicious. |
| record.recent_abuse | boolean | This value will indicate if there has been any recently verified abuse across our network for this IP address. Abuse could be a confirmed chargeback, compromised device, fake app install, or similar malicious behavior within the past few days. |
| record.is_blacklisted | boolean | This value will indicate if the IP has been blocklisted by multiple third-party agencies for spam, abuse or fraud. |
| record.is_private | boolean | This value will indicate if the IP is a private, non-routable IP address. |
| record.is_mobile | boolean | This value will indicate if the IP is likely owned by a mobile carrier. |
| record.has_open_ports | boolean | This value will indicate if the IP has recently had open (listening) ports. |
| record.is_hosting_provider | boolean | This value will indicate if the IP is likely owned by a hosting provider or is leased to a hosting company. |
| record.active_vpn | boolean | Identifies active VPN connections used by popular VPN services and private VPN servers. |
| record.active_tor | boolean | Identifies active TOR exits on the TOR network. |
| record.public_access_point | boolean | Indicates if this IP is likely to be a public access point such as a coffee shop, college or library. |
| record.connection_type | string | Classification of the IP address connection type as "Residential", "Corporate", "Education", "Mobile", "Data Center", or "Unknown". |
| record.abuse_velocity | string | How frequently the IP address is engaging in abuse across the IPQS threat network. Values can be "high", "medium", "low", or "none". |
| record.Country | string |
Two character country code of IP address or "N/A" if unknown. |
| record.City | string |
City of IP address if available or "N/A" if unknown. |
| record.ISP | string |
ISP if one is known. Otherwise "N/A". |
| record.Organization | string |
Organization if one is known. Can be parent company or sub company of the listed ISP. Otherwise "N/A". |
| record.ASN | integer |
Autonomous System Number if one is known. 0 if nonexistent. |
| record.Timezone | string |
Timezone of IP address if available or "N/A" if unknown. |
| record.Latitude | float |
Latitude of IP address if available or 0.00 if unknown. |
| record.Longitude | float |
Longitude of IP address if available or 0.00 if unknown. |
| record.ZeroFraudScore | integer |
The "strictness" = 0 fraud score for this IP address. See Proxy & VPN Detection for details about our fraud scores and the strictness parameter. |
| record.OneFraudScore | integer |
The "strictness" = 1 fraud score for this IP address. See Proxy & VPN Detection for details about our fraud scores and the strictness parameter. |
Additional Resources
Additional documentation is included directly in the Lua database reader. You can view it by running:
luarocks doc ipqs-db-reader
The source code and examples for IPv4 and IPv6 lookups are available in our Github repository.