RepositoryCurrent collected state Current
Observed since 20 Oct, 17:42 UTC
No superseded metadata states collected. Unchanged observations do not create new revisions.
PACKAGE EXPLORERView in registry
abstract-python-ip-geolocation
PyPIAbstractIpGeolocation - Wrapper to quickly start using the powerful AbstractAPI's IP geolocation service in your projects.
Versions collected1
Direct dependencies9From release 1.0.0
Last observed20 Oct, 17:42 UTC
README
Version 1.0.0 documentationAbstractAPI python-ip-geolocation library
Integrate the powerful IP Geolocation API from Abstract in your Python project in a few lines of code.
Abstract's IP Geolocation API is a fast, lightweight, modern, and RESTful JSON API allowing you to look up the location, timezone, country details, and more of an IPv4 or IPv6 address.
It's very simple to use: you only need to submit your API key and an IP address, and the API will respond with an assessment of its geographical location, as well as additional details like the timezone, if it's a VPN address, and more.
Validating and verifying IP addresses is a critical step to reducing the chances of low-quality data and fraudulent or risky users in your website or application.
Documentation
Supported Python Versions
This library supports the Python version 3.6 and higher.
Installation
You can install python-ip-geolocation via PyPi or by downloading the source.
Via Composer:
python-ip-geolocation is available on PyPi as the
abstract-python-ip-geolocation package:
pip install abstract-python-ip-geolocation
API key
Get your API key for free and without hassle from the Abstact website.
Quickstart
Geolocation from an IP Address
# Get a Geolocation from an IP Address Abstract's IP Geolocation API and Python
from python_ip_geolocation import AbstractIpGeolocation
IP_GEOLOCATION_API_KEY = "YYYYYY"; # Get your API Key from https://app.abstractapi.com/api/ip-geolocation/documentation
AbstractIpGeolocation.configure(IP_GEOLOCATION_API_KEY)
AbstractIpGeolocation.look_up("108.177.16.0")
API response
The API response is returned in a IpGeolocationData object.
| PARAMETER | TYPE | DETAILS |
|---|---|---|
| Parameter | Type | Details |
| ip_address | String | The requested IP address |
| city | String | City's name. |
| city_geoname_id | String | City's geoname ID. |
| region | String | State or province in which the the city is located. |
| region_iso_code | Char[2] | State or province's ISO 3166-2 code. |
| region_geoname_id | String | State or province's geoname ID. |
| postal_code | String | ZIP or postal code. |
| country | String | Country's name. |
| country_code | Char[2] | Country's ISO 3166-1 alpha-2 code. |
| country_geoname_id | String | Country's geoname ID. |
| country_is_eu | Boolean | True if the country is in the EU, false if it is not. |
| continent | String | Continent's name. |
| continent_code | Char[2] | 2 letter continent code: AF, AS, EU, NA, OC, SA, AN |
| continent_geoname_id | String | Continent's geoname ID. |
| longitude | Float | Decimal of the longitude. |
| latitude | Float | Decimal of the latitude. |
| security > is_vpn | Boolean | Whether the IP address is using from a VPN or using a proxy |
| timezone > name | String | Timezone's name from the IANA Time Zone Database. |
| timezone > abbreviation | String | Timezone's abbreviation, also from the IANA Time Zone Database. |
| timezone > gmt_offset | String | Timezone's offset from Greenwich Mean Time (GMT). |
| timezone > current_time | String | Current time in the local time zone. |
| timezone > is_dst | Boolean | True if the location is currently in Daylight Savings Time (DST). |
| flag > svg | String | Link to a hosted version of the country's flag in SVG format. |
| flag > png | String | Link to a hosted version of the country's flag in PNG format. |
| flag > emoji | String | Country's flag as an emoji. |
| flag > unicode | String | Country's flag in unicode. |
| currency > currency_name | String | The currency's name. |
| currency > currency_code | String | The currency's code in ISO 4217 format. |
| connection > connection_type | String | Type of network connection: Dialup, Cable/DSL, Cellular, Corporate |
| connection > autonomous_system_number | Uint32 | Autonomous System number |
| connection > autonomous_system_organization | String | Autonomous System Organization name. |
| connection > isp_name | String | Internet Service Provider (ISP) name. |
| connection > organization_name | String | Organization name. |
Detailed documentation
You will find additional information and request examples in the Abstract help page.
Getting help
If you need help installing or using the library, please contact Abstract's Support.
For bug report and feature suggestion, please use this repository issues page.
Contribution
Contributions are always welcome, as they improve the quality of the libraries we provide to the community.
Please provide your changes covered by the appropriate unit tests, and post them in the pull requests page.
Setup
To install the requirements, run:
python3 setup.py install --user
Once you implementer all your changes and the unit tests, run the following command to run the tests:
IP_GEOLOCATION_API_KEY=YYYYYY python3 tests/test_python_ip_geolocation.py
Downloads & popularity
Awaiting observationsNo metric observations yet
Download counts and popularity will appear here as the collector receives them.
Versions 1
Collected releases| Version | Published | Direct dependencies | Open version |
|---|---|---|---|
| 1.0.0 | 21 Apr 2021 | 9 |
Package advisories
0No matching advisories collected
This describes our collected data; it is not a security assessment.
Repository
PENDINGabstractapi/python-ip-geolocation
Shared repository data · GitHub
- License detected in repository
- Not collected
Metadata history
Meaningful changesRecord identity
package:16a2504c467c75ae2c8864d4a6d543712fed8b0d75d89a811aa1bf4115ac74ea