Skip to contents

Agency Awards Information

Source: R/agency.R
agency_awards.Rd

Functions to retrieve award information for federal agencies, including counts, transaction data, and new award metrics.

Usage

agency_awards(toptier_code, fiscal_year = NULL, .page_all = FALSE, ...)

agency_awards_count(toptier_code, fiscal_year = NULL, ...)

agency_awards_count_all(fiscal_year = NULL, .page_all = FALSE, ...)

Arguments

toptier_code

A character string containing a 3-4 digit numeric code that uniquely identifies a top-tier federal agency (e.g., "086" for Department of Housing and Urban Development). Must be a valid CGAC (Common Government-wide Accounting Classification) or FREC (Federal Record Classification) code.

fiscal_year

Optional numeric value specifying the fiscal year for the query. If NULL (default), the API will use the current fiscal year. Must be 2017 or later.

.page_all

Logical indicating whether to retrieve all pages of results (TRUE) or just the first page (FALSE, default). When TRUE, the function will automatically handle pagination to retrieve the complete dataset.

...

Additional parameters passed to specific API endpoints. Common options include:

  • page: Integer specifying the page number to retrieve (default: 1)

  • limit: Integer specifying number of records per page (default: 10)

  • sort: Field to sort results by (varies by endpoint)

  • order: Sort direction: "asc" or "desc" (default varies by endpoint)

Value

Each function returns a tibble with different structures:

  • agency_awards() returns:

    • toptier_code: Agency identifier code

    • fiscal_year: Fiscal year of the awards

    • latest_action_date: Date of most recent award action

    • transaction_count: Number of award transactions

    • obligations: Total award obligations amount

  • agency_awards_count() returns:

    • toptier_code: Agency identifier code

    • fiscal_year: Fiscal year requested

    • new_award_count: Count of new awards for the period

  • agency_awards_count_all() returns:

    • page_metadata: Pagination information

    • results: List of agencies with award counts by type

See also

agency_obligations_by_award_category(), agency_overview()

Examples

if (FALSE) { # interactive()
# Get 2023 awards for HUD with all pages
hud_awards <- agency_awards("086", 
                           fiscal_year = 2023,
                           .page_all = TRUE)
                           
# Get award counts for HUD in fiscal year 2023
award_counts <- agency_awards_count("086", fiscal_year = 2023)

# Get award counts across all agencies
all_counts <- agency_awards_count_all(fiscal_year = 2023)
}