Skip to contents

This function retrieves information about a specified API.

Usage

api_info(x)

Arguments

x

A character string specifying the API host for which information is to be retrieved or an object of class ApiCredentials.

Value

A list containing information about the specified API. Throws an error if the API is not available.

See also

api_login() to retrieve the login object.

api_ping() to check if the API is available.

Examples

if (FALSE) { # \dontrun{
api_info("https://api.example.com")

creds <- api_login("https://api.example.com", "username", "password")
api_info(creds)
} # }