Package 'ipbase'

Title: Client for the 'ipbase.com' IP Geolocation API
Description: An R client for the 'ipbase.com' IP Geolocation API. The API requires registration of an API key. Basic features are free, some require a paid subscription. You can find the full API documentation at <https://ipbase.com/docs> .
Authors: Dominik Kukacka [aut, cre]
Maintainer: Dominik Kukacka <[email protected]>
License: MIT + file LICENSE
Version: 0.1.1
Built: 2024-11-06 05:12:17 UTC
Source: https://github.com/cran/ipbase

Help Index

Get the current status of the API.

Description

Get the current status of the API.

Usage

get_api_status()

Value

Returns your current quota. Requests to this endpoint do not count against your quota or rate limit.

Retrieves information for a specific ASN (autonomous system number).

Description

Retrieves information for a specific ASN (autonomous system number).

Usage

get_asn_info(asn = NULL)

Arguments

asn

(required) The ASN you want to query

Value

Returns all available information about an ASN.

Retrieves all domains hosted on a single IP address

Description

Retrieves all domains hosted on a single IP address

Usage

get_domain_info(ip = NULL, page = NULL, limit = NULL)

Arguments

ip

(required) The IP you want to query the domains for
page

The page for iterating through all domains
limit

The amount of domains you want to see on each page

Value

Retrieves all domains hosted on a single IP address

Checks the provided IP address (both v4 & v6 formats) and returns all available information.

Description

Checks the provided IP address (both v4 & v6 formats) and returns all available information.

Usage

get_ip_info(ip = NULL, language = NULL, hostname = NULL)

Arguments

ip

The IP address you want to query
language

An ISO Alpha 2 Language Code for localizing the IP data
hostname

If the hostname parameter is set to 1, the API response will contain the hostname of the IP

Value

Returns all available information about an IP address.

Ipbase API Key

Description

ipbase.com requires authentication via an API key. For this package, the API key is saved as a environmental variable. In interactive mode, using ipbase_api_key will require you to enter an API key. Alternatively, you can also use Sys.setenv(IPBASE_API_KEY = <key>) to set the API key manually.

Usage

ipbase_api_key(force = FALSE)

Arguments

force

If TRUE, resets the API key & requires the user to provide a new API key. If FALSE and an API key already exists, the key will be printed to the console. If no key exists, you will be required to enter a key. force. Defaults to FALSE.

Value

Returns the set API key that has been stored as an enviroment variable.