PetfindeR (version 2.1.0)

Petfinder: Creates an authenticated connection with the Petfinder API. The stored authentication is then used to call the Petfinder API methods. An API key can be obtained from Petfinder by creating an account on their developer page (https://www.petfinder.com/developers/api-key). The function wraps the .Petfinder.class R6 class.

Description

Creates an authenticated connection with the Petfinder API. The stored authentication is then used to call the Petfinder API methods. An API key can be obtained from Petfinder by creating an account on their developer page (https://www.petfinder.com/developers/api-key). The function wraps the .Petfinder.class R6 class.

Usage

Petfinder(key, secret)

Arguments

key

The API key received from Petfinder

secret

The secret key received from Petfinder along with the API key.

Value

Intialized Petfinder object that is then used to access the API.

Examples

# NOT RUN {
pf <- Petfinder(key) # Creates the connection with the Petfinder API.
pf$breeds('cat') # The connection can now be used to access the Petfinder API methods.
# }