Skip to content

Latest commit

 

History

History
117 lines (88 loc) · 7.34 KB

README.md

File metadata and controls

117 lines (88 loc) · 7.34 KB
Raw

IP2Location 8.6.2

This is a IP2Location Python library that enables the user to find the country, region or state, city, latitude and longitude, ZIP code, time zone, Internet Service Provider (ISP) or company name, domain name, net speed, area code, weather station code, weather station name, mobile country code (MCC), mobile network code (MNC) and carrier brand, elevation, usage type, address type and IAB category by IP address or hostname originates from. The library reads the geo location information from IP2Location BIN data file.

Supported IPv4 and IPv6 address.

For more details, please visit: https://www.ip2location.com/developers/python

Requirements

  1. Python 2.2 and above

Installation

  1. Unzip the package.
  2. Execute python setup.py build
  3. Execute python setup.py install

or

To install this module type the following (for PyPI):

pip install IP2Location

Usage

You can check the sample.py file to learn more about usage.

BIN Database

Below is the description of the functions available in the BIN Database lookup.

Method Name Description
open Open the IP2Location BIN data for lookup. Default mode: File I/O.
close Close and clean up the file pointer.
get_all Return the geolocation information in array.
get_country_short Return the ISO3166-1 country code (2-digits) of the IP address.
get_country_long Return the ISO3166-1 country name of the IP address.
get_region Return the ISO3166-2 region name of the IP address. Please visit ISO3166-2 Subdivision Code for the information of ISO3166-2 supported
get_city Return the city name of the IP address.
get_latitude Return the city latitude of the IP address.
get_longitude Return the city longtitude of the IP address.
get_isp Return the ISP name of the IP address.
get_domain Return the domain name of IP address.
get_zipcode Return the zipcode of the city.
get_timezone Return the UTC time zone (with DST supported).
get_netspeed Return the Internet connection type. Please see Internet Connection Type for details.
get_idd_code Return the IDD prefix to call the city from another country.
get_area_code Return the area code of the city.
get_weather_code Return the nearest weather observation station code.
get_weather_name Return the nearest weather observation station name.
get_mcc Return the Mobile Country Codes (MCC).
get_mnc Return the Mobile Network Code (MNC).
get_mobile_brand Commercial brand associated with the mobile carrier. Please visit Mobile Carrier Coverage to view the coverage report.
get_elevation Return average height of city above sea level in meters (m).
get_usage_type Return the ISP's usage type of IP address. Please see Usage Type for details.
get_address_type Return the IP address type (A-Anycast, B-Broadcast, M-Multicast & U-Unicast) of IP address or domain name.
get_category Return the IAB content taxonomy category of IP address or domain name. You can get a full list of IAB content taxonomy category from here.

Web Service

Below is the description of the functions available in the Web Service lookup.

Function Name Description
Constructor Expect 3 input parameters:
  1. IP2Location API Key.
  2. Package (WS1 - WS25)
  3. 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
  • address_type
  • category
  • category_name
  • 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
    • sunrise
    • sunset
    get_credit Return remaining credit of the web service account.

    Testing

    python sample.py
python test.py
python lookup.py <ip_address>

    Sample BIN Databases

    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.

    Internet Connection Type

    Internet Connection Type Description
    DIAL Dial Up
    DSL Broadband/Cable/Fiber/Mobile
    COMP Company/T1

    Usage Type

    Usage Type Description
    COM Commercial
    ORG Organization
    GOV Government
    MIL Military
    EDU University/College/School
    LIB Library
    CDN Content Delivery Network
    ISP Fixed Line ISP
    MOB Mobile ISP
    DCH Data Center/Web Hosting/Transit
    SES Search Engine Spider
    RSV Reserved

    Support

    Email: support@ip2location.com.
    URL: https://www.ip2location.com