https://github.com/ip2location/steampipe-plugin-ip2locationio
Use SQL to instantly query ip2location.io for IP address or WHOIS information. Open source CLI. No DB required.
https://github.com/ip2location/steampipe-plugin-ip2locationio
Last synced: about 2 months ago
JSON representation
Use SQL to instantly query ip2location.io for IP address or WHOIS information. Open source CLI. No DB required.
- Host: GitHub
- URL: https://github.com/ip2location/steampipe-plugin-ip2locationio
- Owner: ip2location
- License: apache-2.0
- Created: 2023-06-21T00:50:17.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-07T02:51:09.000Z (about 1 year ago)
- Last Synced: 2026-05-13T10:49:54.216Z (2 months ago)
- Language: Go
- Homepage: https://hub.steampipe.io/plugins/ip2location/ip2locationio
- Size: 149 KB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# IP2Location.io Plugin for Steampipe
Use SQL to retrieve geolocation or WHOIS info in minutes using [ip2location.io](https://ip2location.io).
- **[Get started →](https://hub.steampipe.io/plugins/ip2location/ip2locationio)**
- Documentation: [Table definitions & examples](https://hub.steampipe.io/plugins/ip2location/ip2locationio/tables)
- Community: [Slack Channel](https://steampipe.io/community/join)
- Get involved: [Issues](https://github.com/ip2location/steampipe-plugin-ip2locationio/issues)
## Quick start
Install the plugin with [Steampipe](https://steampipe.io):
```sh
steampipe plugin install ip2location/ip2locationio
```
Configure the server address in `~/.steampipe/config/ip2locationio.spc`:
```hcl
connection "ip2locationio" {
plugin = "ip2location/ip2locationio"
# API key for requests. Required.
# Sign up for a free key at https://www.ip2location.io/pricing
# This can also be set via the `IP2LOCATIONIO_API_KEY` environment variable.
# api_key = "Q5Z8QS544RKC2VK4P3ZH7YW3C16MDCBW"
}
```
Or through environment variables:
```sh
export IP2LOCATIONIO_API_KEY=Q5Z8QS544RKC2VK4P3ZH7YW3C16MDCBW
```
Run steampipe:
```sh
steampipe query
```
Query IP geolocation:
```sql
select
country_code,
country_name,
region_name,
city_name
from
ip2locationio_geolocation
where
ip = '8.8.8.8';
```
```
+--------------+--------------------------+-------------+---------------+
| country_code | country_name | region_name | city_name |
+--------------+--------------------------+-------------+---------------+
| US | United States of America | California | Mountain View |
+--------------+--------------------------+-------------+---------------+
```
Query WHOIS data:
```sql
select
domain,
domain_id,
status,
create_date
from
ip2locationio_whois
where
domain = 'google.com';
```
```
+------------+-------------------------+---------------------------------------------------------------------------+----------------------+
| domain | domain_id | status | create_date |
+------------+-------------------------+---------------------------------------------------------------------------+----------------------+
| google.com | 2138514_DOMAIN_COM-VRSN | clientUpdateProhibited (https://www.icann.org/epp#clientUpdateProhibited) | 1997-09-15T07:00:00Z |
+------------+-------------------------+---------------------------------------------------------------------------+----------------------+
```
Query IP hosted domains:
```sql
select
total_domains,
page,
per_page,
total_pages,
domains
from
ip2locationio_hosted
where
ip = '8.8.8.8';
```
```
+---------------+------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------->
| total_domains | page | per_page | total_pages | domains >
+---------------+------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------->
| 3861 | 1 | 100 | 39 | ["000180.top","00100tet.xyz","001hash.vip","002hash.com","0050500.xyz","007515.com","023mm.net","023mt.net","023sn.net","031000.xyz","0515>
| | | | | xyz","20230406.mov","205566.com","205artemisbet.com","20iiij.cyou","21107ahsfukhweo.com","21hodheoh.cyou","22bahman.space","22howhw.cyou",>
+---------------+------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------->
```
## Developing
Prerequisites:
- [Steampipe](https://steampipe.io/downloads)
- [Golang](https://golang.org/doc/install)
Clone:
```sh
git clone https://github.com/ip2location/steampipe-plugin-ip2locationio.git
cd steampipe-plugin-ip2locationio
```
Build, which automatically installs the new version to your `~/.steampipe/plugins` directory:
```sh
make
```
Configure the plugin:
```sh
cp config/* ~/.steampipe/config
nano ~/.steampipe/config/ip2locationio.spc
```
Try it!
```
steampipe query
> .inspect ip2locationio
```
Further reading:
- [Writing plugins](https://steampipe.io/docs/develop/writing-plugins)
- [Writing your first table](https://steampipe.io/docs/develop/writing-your-first-table)
## Contributing
Please see the [contribution guidelines](https://github.com/turbot/steampipe/blob/main/CONTRIBUTING.md) and our [code of conduct](https://github.com/turbot/steampipe/blob/main/CODE_OF_CONDUCT.md). All contributions are subject to the [Apache 2.0 open source license](https://github.com/ip2location/steampipe-plugin-ip2locationio/blob/main/LICENSE).
`help wanted` issues:
- [Steampipe](https://github.com/turbot/steampipe/labels/help%20wanted)
- [ip2location.io Plugin](https://github.com/ip2location/steampipe-plugin-ip2locationio/labels/help%20wanted)