cfbd_info_usage: *Get API key usage information*

In cfbfastR: Access College Football Play by Play Data

Get API key usage information

Description

Get API key usage information Call volume and remaining quota for the configured CFBD API key.

Usage

cfbd_info_usage(days = NULL, limit = NULL, api = NULL, proxy = NULL)

Arguments

days	(Integer optional): Look-back window in days.
limit	(Integer optional): Maximum rows to return.
api	(String optional): API filter – all, cfb or cbb.
proxy	(List optional): Per-call proxy override passed to get_req(). NULL (default) falls back to getOption("cfbfastR.proxy") and then the ⁠http(s)_proxy⁠ environment variables, so a caller can override the shared setting for one endpoint.

Value

cfbd_info_usage() - A tibble with 11 columns:

col_name	types	description
api	character	API the request was made against (cfb or cbb).
endpoint	character	API endpoint path.
kind	character	Row type -- top_endpoint (aggregated count) or recent_request (single event).
requests	integer	Number of requests recorded.
occurred_at	character	Timestamp for the row (last use for top_endpoint, request time for recent_request).
window_start	character	Start of the reporting window (ISO 8601).
window_end	character	End of the reporting window (ISO 8601).
total_requests	integer	Total requests in the window.
total_cfb_requests	integer	College football requests in the window.
total_cbb_requests	integer	College basketball requests in the window.
unique_endpoints	integer	Distinct endpoints called in the window.

Examples

  try(cfbd_info_usage())

cfbfastR documentation built on Aug. 24, 2026, 5:13 p.m.