Skip to main content

Python API for IP2Location database.

Project description

IP2Location 8.5.1

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, and usage type 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.

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 - WS24)
  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
  • 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

    Project details


    Download files

    Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

    Source Distribution

    ip2l-8.5.1.tar.gz (4.0 kB view details)

    Uploaded Source

    Built Distributions

    ip2l-8.5.1-py3-none-any.whl (9.1 kB view details)

    Uploaded Python 3

    ip2l-8.5.1-py2.py3-none-any.whl (9.1 kB view details)

    Uploaded Python 2Python 3

    File details

    Details for the file ip2l-8.5.1.tar.gz.

    File metadata

    • Download URL: ip2l-8.5.1.tar.gz
    • Upload date:
    • Size: 4.0 kB
    • Tags: Source
    • Uploaded using Trusted Publishing? No
    • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.7

    File hashes

    Hashes for ip2l-8.5.1.tar.gz
    Algorithm Hash digest
    SHA256 bc9924c6093da8fa08dbd64e081042b6bac4b49a155c3abf6b72d615f40cde32
    MD5 0194bcaf7b43099c9e3637801d56fbfe
    BLAKE2b-256 31be7e59bc31d8fe79125c3330aa88927a9028a686cfdb57cedf637ba2068cc0

    See more details on using hashes here.

    File details

    Details for the file ip2l-8.5.1-py3-none-any.whl.

    File metadata

    • Download URL: ip2l-8.5.1-py3-none-any.whl
    • Upload date:
    • Size: 9.1 kB
    • Tags: Python 3
    • Uploaded using Trusted Publishing? No
    • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.7

    File hashes

    Hashes for ip2l-8.5.1-py3-none-any.whl
    Algorithm Hash digest
    SHA256 a14381b7fe11147cb481c8271cfb8d2ed112f685464c574a3a956f0de28215de
    MD5 c6169fe429e44923bba55906e449c9c6
    BLAKE2b-256 b371688158fc686d3c99eb1d14d0d1f404656b922f5ae33d62208036fb5353c6

    See more details on using hashes here.

    File details

    Details for the file ip2l-8.5.1-py2.py3-none-any.whl.

    File metadata

    • Download URL: ip2l-8.5.1-py2.py3-none-any.whl
    • Upload date:
    • Size: 9.1 kB
    • Tags: Python 2, Python 3
    • Uploaded using Trusted Publishing? No
    • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.7

    File hashes

    Hashes for ip2l-8.5.1-py2.py3-none-any.whl
    Algorithm Hash digest
    SHA256 3fa941d83e240612c1ff0f217f83cf1e842dc4c36bf2c275cd7cb35547e224c8
    MD5 e4ed15649f456e49a9dd6f5eba55cd2e
    BLAKE2b-256 191cfe9b0a0f7922a6e25a19120a4e9f44001374d00c8736cb7787572c6463b2

    See more details on using hashes here.

    Supported by

    AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page