Get API key usage information Call volume and remaining quota for the configured CFBD API key.
Arguments
- days
(Integer optional): Look-back window in days.
- limit
(Integer optional): Maximum rows to return.
- api
(String optional): API filter –
all,cfborcbb.- proxy
(List optional): Per-call proxy override passed to
get_req().NULL(default) falls back togetOption("cfbfastR.proxy")and then thehttp(s)_proxyenvironment 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
# \donttest{
try(cfbd_info_usage())
#> ── Get API key usage information from CollegeFootballData.com ──────────────────
#> ℹ Data updated: 2026-10-12 12:59:16 UTC
#> # A tibble: 20 × 11
#> api endpoint kind requests occurred_at window_start window_end
#> <chr> <chr> <chr> <int> <chr> <chr> <chr>
#> 1 cfb /plays/stats top_e… 3341 2026-10-12… 2026-10-05T… 2026-10-1…
#> 2 cfb /games top_e… 2352 2026-10-12… 2026-10-05T… 2026-10-1…
#> 3 cfb /drives top_e… 1989 2026-10-12… 2026-10-05T… 2026-10-1…
#> 4 cfb /lines top_e… 1931 2026-10-12… 2026-10-05T… 2026-10-1…
#> 5 cfb /plays top_e… 1789 2026-10-12… 2026-10-05T… 2026-10-1…
#> 6 cfb /recruiting/players top_e… 1317 2026-10-12… 2026-10-05T… 2026-10-1…
#> 7 cfb /roster top_e… 1013 2026-10-12… 2026-10-05T… 2026-10-1…
#> 8 cfb /teams top_e… 783 2026-10-12… 2026-10-05T… 2026-10-1…
#> 9 cfb /teams/matchup top_e… 771 2026-10-12… 2026-10-05T… 2026-10-1…
#> 10 cfb /recruiting/teams top_e… 692 2026-10-12… 2026-10-05T… 2026-10-1…
#> 11 cfb /info/usage recen… NA 2026-10-12… 2026-10-05T… 2026-10-1…
#> 12 cfb /ppa/predicted recen… NA 2026-10-12… 2026-10-05T… 2026-10-1…
#> 13 cfb /ppa/predicted recen… NA 2026-10-12… 2026-10-05T… 2026-10-1…
#> 14 cfb /ppa/players/season recen… NA 2026-10-12… 2026-10-05T… 2026-10-1…
#> 15 cfb /ppa/players/games recen… NA 2026-10-12… 2026-10-05T… 2026-10-1…
#> 16 cfb /games/players recen… NA 2026-10-12… 2026-10-05T… 2026-10-1…
#> 17 cfb /ppa/games recen… NA 2026-10-12… 2026-10-05T… 2026-10-1…
#> 18 cfb /games/weather recen… NA 2026-10-12… 2026-10-05T… 2026-10-1…
#> 19 cfb /metrics/fg/ep recen… NA 2026-10-12… 2026-10-05T… 2026-10-1…
#> 20 cfb /scoreboard recen… NA 2026-10-12… 2026-10-05T… 2026-10-1…
#> # ℹ 4 more variables: total_requests <int>, total_cfb_requests <int>,
#> # total_cbb_requests <int>, unique_endpoints <int>
# }