get_key_usage: Get the key usage

View source: R/get_key_usage.R

get_key_usageR Documentation

Get the key usage

Description

wrapper around https://api.originstamp.com/swagger/swagger-ui.html#/API_Key/getApiKeyUsage. The function downloads information about the api key.

Usage

get_key_usage(
  error_on_fail = TRUE,
  url = api_url(),
  key = api_key(),
  save_raw_response_to = NULL,
  load_raw_response_from = NULL
)

Arguments

error_on_fail

if TRUE, raise error when api call fails, otherwise return the failed response.

url

the url of the api. The default is to use the url as returned by the function api_url()

key

the api key. The default is to use the key as returned by the function api_key()

save_raw_response_to

save the response to a file in rds format

load_raw_response_from

load the response from a file in rds format

Value

object of class OriginStampResponse.

Examples


## Not run: 
# Retrieve complete merkle tree proof
get_key_usage()

## End(Not run)

rkrug/ROriginStamp documentation built on Aug. 16, 2022, 5:45 p.m.