artemklevtsov/ip-api.R

## ip-api.R
#' @title Geolocate IP Addresses Through ip-api.com
#' @description
#' \code{geolocate} consumes a vector of IP addresses and geolocates them via
#' \href{http://ip-api.com}{ip-api.com}.
#' @param ip a character vector of IP addresses.
#' @param lang a string to specify an output localisation language.
#' Allowed values: en, de, es, pt-BR, fr, ja, zh-CN, ru.
#' @param fields a string to specify which fields to return.
#' @param delay a logical to whether or not to delay each request by 400ms.
#' ip-api.com has a maximum threshold of 150 requests a minute. Disable it for
#' the pro account.
#' @return A data frame with geolocation information.
#' @references http://ip-api.com/docs/api:batch
#' @author Artem Klevtsov \email{a.a.klevtsov@gmail.com}
#' @importFrom crul HttpClient
#' @importFrom jsonlite fromJSON rbind.pages
geolocate <- function(ip, lang = "en", fields = "258047", delay = TRUE) {
    cl <- crul::HttpClient$new(url = "http://ip-api.com")
    lang <- match.arg(lang, c("en", "de", "es", "pt-BR", "fr", "ja", "zh-CN", "ru"))
    query <- list(lang = lang, fields = fields)
    if (missing(ip) || ip == "") {
        resp <- cl$post(path = "json", query = query)
        parsed <- jsonlite::fromJSON(resp$parse("UTF-8"))
        return(as.data.frame(parsed))
    }
    ip <- unique(ip)
    get_data <- function(ip, query = NULL, delay = TRUE) {
        body <- data.frame(query = ip)
        if (delay) Sys.sleep(0.4)
        resp <- cl$post(path = "batch", query = query, encode = "json", body = body)
        resp$raise_for_status()
        parsed <- jsonlite::fromJSON(resp$parse("UTF-8"))
        return(parsed)
    }
    if (length(ip) > 100L) {
        by <- seq_along(ip) - 1 %/% 100L
        splitted <- unname(split(ip, by))
        res <- lapply(splitted, get_data, query = query, delay = delay)
        res <- jsonlite::rbind.pages(res)
    } else {
        res <- get_data(ip, query = query, delay = delay)
    }
    return(res)
}
	#' @title Geolocate IP Addresses Through ip-api.com
	#' @description
	#' \code{geolocate} consumes a vector of IP addresses and geolocates them via
	#' \href{http://ip-api.com}{ip-api.com}.
	#' @param ip a character vector of IP addresses.
	#' @param lang a string to specify an output localisation language.
	#' Allowed values: en, de, es, pt-BR, fr, ja, zh-CN, ru.
	#' @param fields a string to specify which fields to return.
	#' @param delay a logical to whether or not to delay each request by 400ms.
	#' ip-api.com has a maximum threshold of 150 requests a minute. Disable it for
	#' the pro account.
	#' @return A data frame with geolocation information.
	#' @references http://ip-api.com/docs/api:batch
	#' @author Artem Klevtsov \email{a.a.klevtsov@gmail.com}
	#' @importFrom crul HttpClient
	#' @importFrom jsonlite fromJSON rbind.pages
	geolocate <- function(ip, lang = "en", fields = "258047", delay = TRUE) {
	cl <- crul::HttpClient$new(url = "http://ip-api.com")
	lang <- match.arg(lang, c("en", "de", "es", "pt-BR", "fr", "ja", "zh-CN", "ru"))
	query <- list(lang = lang, fields = fields)
	if (missing(ip) \|\| ip == "") {
	resp <- cl$post(path = "json", query = query)
	parsed <- jsonlite::fromJSON(resp$parse("UTF-8"))
	return(as.data.frame(parsed))
	}
	ip <- unique(ip)
	get_data <- function(ip, query = NULL, delay = TRUE) {
	body <- data.frame(query = ip)
	if (delay) Sys.sleep(0.4)
	resp <- cl$post(path = "batch", query = query, encode = "json", body = body)
	resp$raise_for_status()
	parsed <- jsonlite::fromJSON(resp$parse("UTF-8"))
	return(parsed)
	}
	if (length(ip) > 100L) {
	by <- seq_along(ip) - 1 %/% 100L
	splitted <- unname(split(ip, by))
	res <- lapply(splitted, get_data, query = query, delay = delay)
	res <- jsonlite::rbind.pages(res)
	} else {
	res <- get_data(ip, query = query, delay = delay)
	}
	return(res)
	}