geohost: IP address lookup

In madlogos/asesgeo: ASES Analytic Toolkit on Geographics

Description

geocodes an IP address using either ipify.org (https://www.ipify.org), ipstack.com (https://ipstack.com) or ipinfo.io (http://ipinfo.io/developers) IP lookup API.

Usage

geohost(ip = "", api = c("ipinfo", "ipify", "ipstack"),
  output = c("country", "region", "city", "all", "raw"),
  use_curl = FALSE, time = 0, key = NULL)

Arguments

ip	a character vector specifying IPs (IPv4 or IPv6) (e.g., "12.215.42.19"). The default value is no IP is specified and the host IP is used.
api	use 'ipify' (ipify.org), 'ipstack' (ipstack.com) or 'ipinfo'(ipinfo.io) lookup API. By default 'ipinfo' is used.
output	character, 'country', 'region', 'city', 'all' or 'raw'. It decides which columns to return in the output data.frame. 'country': ip and country 'region': ip, region and country 'city': ip, city, region and country 'all': all the info 'raw': the raw JSON list. You can then apply parse_geohosts to process the list for structured data.
use_curl	logical, whether use curl to access the APIs. Default FALSE.
time	numeric, time interval to lookup the IP address, by seconds. It is used to avoid overuse of the APIs. Default 0.
key	character, the api key for ipinfo or ipstack. Default NULL, which indicates that the function will try to find it in cache. When no match is found, a GUI wizard will be launched for you to enter the key. If the API does not call for a key, set it to NA.

Details

note that ipstack.com API is allowed up to 10,000 queries per month by default, ipinfo API is limited to 1,000 requests per day, and ipify.org API is limited to 1,000 requests per month.

Value

a data.frame.

Author(s)

Jun Cai ([e-mail]), PhD student from Center for Earth System Science, Tsinghua University
Yiying Wang ([e-mail])

References

• ipipy.org IP lookup API at https://www.ipify.org
  

• ipstack.com IP lookup API at https://ipstack.com/documentation
  

• ipinfo.io IP lookup API at https://ipinfo.io/developers

See Also

geocode, revgeocode, parse_geohosts.

synthesize_ipinfo_api(), synthesize_ipify_api(), synthesize_ipstack_api()

Examples

## Not run: 
# geocode host IP
geohost()
geohost(api = "ipinfo")

# specify an IP for geocoding
geohost(ip = "12.215.42.19")
geohost(ip = "12.215.42.19", api = "ipinfo")

# geocode multiple IPs
geohost(ip = c("61.135.169.81", "12.215.42.19"))
geohost(ip = c("61.135.169.81", "12.215.42.19"), api = "ipinfo")

## End(Not run)

madlogos/asesgeo documentation built on Aug. 9, 2019, 9:53 a.m.