README

This is the official release maintained by IP2Location.com

This PHP module provides fast lookup of country, region, city, latitude, longitude, ZIP code, time zone, ISP, domain name, connection speed, IDD code, area code, weather station code, weather station name, MNC, MCC, mobile brand, elevation, and usage type from IP address by using IP2Location database. This module uses a file based database available at IP2Location.com.

This module can be used in many types of projects such as:

select the geographically closest mirror
analyze your web server logs to determine the countries of your visitors
credit card fraud detection
software export controls
display native language and currency
prevent password sharing and abuse of service
geotargeting in advertisement

Free IP2Location LITE and commerical databases are available for download.

LITE database is available at https://lite.ip2location.com (Free with limited accuracy)
Commercial database is availabe at https://www.ip2location.com (Comprehensive with high accuracy)

Monthly update is available for both IP2Location LITE and commercial database.

KEY FEATURES

Support both IPv4 and IPv6 with ease. If you would like to enable IPv6 support, you just need to replace your BIN file with IPv6 version. That's it, and no code modification needed.
Extensible. If you require different granularity of IP information, you can visit IP2Location.com to download the relevant BIN file, and the information will made ready for you.
Comprehensive Information. There are more than 13 types of information that you can retrieve from an IP address. Please visit IP2Location.com for details.

INSTALLATION

To install this module, unzip the package and copy the following files to your web folder.

IP2Location.php
example.php
databases/IP2LOCATION-LITE-DB1.BIN

To test this installation, please browse example.php using web browser.

USAGE

You can check the example.php file to learn more about usage.

Database Class

Below is the description of the functions available in the Database class.

Function Name	Description
Constructor	Expect 2 input parameters: Full path of IP2Location BIN data file. File Open Mode SHARED_MEMORY MEMORY_CACHE FILE_IO For SHARED_MEMORY and MEMORY_CACHE, it will require your server to have sufficient memory to hold the BIN data, otherwise it will raise the errors during the object initialization.
getDate	Return the database's compilation date as a string of the form 'YYYY-MM-DD'
getType	Return the database's type, 1 to 24 respectively for DB1 to DB24. Please visit https://www.ip2location.com/databases for details.
getModuleVersion	Return the version of module
getDatabaseVersion	Return the version of database
lookup	Return the IP information in array. Below is the information returned: ipNumber ipVersion ipAddress countryCode countryName regionName cityName latitude longitude areaCode iddCode weatherStationCode weatherStationName mcc mnc mobileCarrierName usageType elevation netSpeed timeZone zipCode domainName isp You can visit IP2Location for the description of each field. Note: although the above names are not exactly matched with the names given in this link, but they are self-described.
getCidr	Return an array of the sub-network of an IP address.

WebService Class

Below is the description of the functions available in the WebService class.

Function Name	Description
Constructor	Expect 3 input parameters: IP2Location API Key. Package (WS1 - WS24) Use HTTPS or HTTP
lookup	Return the IP information in array. country_code country_name region_name city_name latitude longitude zip_code time_zone isp domain net_speed idd_code area_code weather_station_code weather_station_name mcc mnc mobile_brand elevation usage_type continent name code hemisphere translations country name alpha3_code numeric_code demonym flag capital total_area population currency code name symbol language code name idd_code tld translations region name code translations city name translations geotargeting metro country_groupings time_zone_info olson current_time gmt_offset is_dst
getCredit	Return remaining credit of the web service account.

DEPENDENCIES

This library requires IP2Location BIN data file to function. You may download the BIN data file at

IP2Location LITE BIN Data (Free): https://lite.ip2location.com
IP2Location Commercial BIN Data (Comprehensive): https://www.ip2location.com

An outdated BIN database was provided in the databases folder for your testing. You are recommended to visit the above links to download the latest BIN database.

You can also sign up for IP2Location Web Service to lookup by IP2Location API.

IPv4 BIN vs IPv6 BIN

Use the IPv4 BIN file if you just need to query IPv4 addresses.
Use the IPv6 BIN file if you need to query BOTH IPv4 and IPv6 addresses.

OTHER FRAMEWORK LIBRARY

Below are the list of other framework library that you can install and use right away.

COPYRIGHT AND LICENCE

License under MIT

seeley / ip2location

Maintainers

Details