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-09-10 05:40:38 UTC
#> # A tibble: 20 × 11
#> api endpoint kind requests occurred_at window_start window_end
#> <chr> <chr> <chr> <int> <chr> <chr> <chr>
#> 1 cfb /drives top_… 2144 2026-09-10… 2026-09-03T… 2026-09-1…
#> 2 cfb /lines top_… 2054 2026-09-10… 2026-09-03T… 2026-09-1…
#> 3 cfb /plays top_… 2041 2026-09-10… 2026-09-03T… 2026-09-1…
#> 4 cfb /plays/stats top_… 1943 2026-09-10… 2026-09-03T… 2026-09-1…
#> 5 cfb /recruiting/players top_… 887 2026-09-10… 2026-09-03T… 2026-09-1…
#> 6 cfb /teams/matchup top_… 844 2026-09-10… 2026-09-03T… 2026-09-1…
#> 7 cfb /recruiting/teams top_… 742 2026-09-10… 2026-09-03T… 2026-09-1…
#> 8 cfb /games top_… 685 2026-09-10… 2026-09-03T… 2026-09-1…
#> 9 cfb /stats/player/season top_… 628 2026-09-10… 2026-09-03T… 2026-09-1…
#> 10 cfb /recruiting/groups top_… 627 2026-09-10… 2026-09-03T… 2026-09-1…
#> 11 cfb /info/usage rece… NA 2026-09-10… 2026-09-03T… 2026-09-1…
#> 12 cfb /passing/plays rece… NA 2026-09-10… 2026-09-03T… 2026-09-1…
#> 13 cfb /passing/players/se… rece… NA 2026-09-10… 2026-09-03T… 2026-09-1…
#> 14 cfb /passing/players/ga… rece… NA 2026-09-10… 2026-09-03T… 2026-09-1…
#> 15 cfb /metrics/wp/pregame rece… NA 2026-09-10… 2026-09-03T… 2026-09-1…
#> 16 cfb /games/teams rece… NA 2026-09-10… 2026-09-03T… 2026-09-1…
#> 17 cfb /metrics/wp rece… NA 2026-09-10… 2026-09-03T… 2026-09-1…
#> 18 cfb /wepa/team/season rece… NA 2026-09-10… 2026-09-03T… 2026-09-1…
#> 19 cfb /games/teams rece… NA 2026-09-10… 2026-09-03T… 2026-09-1…
#> 20 cfb /wepa/players/rushi… rece… NA 2026-09-10… 2026-09-03T… 2026-09-1…
#> # ℹ 4 more variables: total_requests <int>, total_cfb_requests <int>,
#> # total_cbb_requests <int>, unique_endpoints <int>
# }