USAspending API ReferenceIndependent
Try the API

Agencies Reporting Overview

GET/api/v2/reporting/agencies/overview/
Powers Agency submission statistics on usaspending.gov

This endpoint is used to power USAspending.gov's About the Data | Agencies Overview table. This data can be used to better understand the ways agencies submit data.

This endpoint returns an overview list of government agencies submission data.

Request

curl 'https://api.usaspending.gov/api/v2/reporting/agencies/overview/?fiscal_year=2020&fiscal_period=10'

Query parameters

  • fiscal_yearstringRequired

    The fiscal year.

    Example 2020

  • fiscal_periodstringRequired

    The fiscal period. Valid values: 2-12 (2 = November ... 12 = September) For retriving quarterly data, provide the period which equals 'quarter * 3' (e.g. Q2 = P6)

    Example 10

  • filterstring

    The agency name or abbreviation to filter on (partial match, case insesitive).

  • pagestring

    The page of results to return based on the limit.

    Default 1

  • limitstring

    The number of results to include per page.

    Default 10

  • orderenum (string)

    The direction (asc or desc) that the sort field will be sorted in.

    Allowed values
    • asc
    • desc

    Default desc

  • sortenum (string)

    A data field that will be used to sort the response array.

    Allowed values
    • toptier_code
    • current_total_budget_authority_amount
    • tas_accounts_total
    • missing_tas_accounts_count
    • agency_name
    • obligation_difference
    • recent_publication_date
    • recent_publication_date_certified
    • tas_obligation_not_in_gtas_total
    • unlinked_contract_award_count
    • unlinked_assistance_award_count

    Default current_total_budget_authority_amount

Try it

Runs against the live API. Responses are real data.

GET/api/v2/reporting/agencies/overview/?fiscal_year=2020&fiscal_period=10

Response · 200

  • page_metadataobject · PaginationMetadataRequired7 fields
    • pagenumberRequired
    • nextnumberRequiredNullable
    • previousnumberRequiredNullable
    • hasNextbooleanRequired
    • hasPreviousbooleanRequired
    • totalnumberRequired
    • limitnumberRequired
  • resultsarray of AgencyDataRequired12 fields
    • agency_namestringRequired
    • abbreviationstringRequired
    • toptier_codestringRequired
    • agency_idnumberRequiredNullable
    • current_total_budget_authority_amountnumberRequiredNullable
    • recent_publication_datestringRequiredNullable
    • recent_publication_date_certifiedbooleanRequired
    • tas_account_discrepancies_totalsarray of TASTotalsRequired4 fields
      • gtas_obligation_totalnumberRequiredNullable
      • tas_accounts_totalnumberRequiredNullable
      • tas_obligation_not_in_gtas_totalnumberRequiredNullable
      • missing_tas_accounts_countnumberRequiredNullable
    • obligation_differencenumberRequiredNullable

      The difference in File A and File B obligations.

    • unlinked_contract_award_countnumberRequiredNullable
    • unlinked_assistance_award_countnumberRequiredNullable
    • assurance_statement_urlstringRequiredNullable
  • messagesarray of string

    An array of warnings or instructional directives to aid consumers of this endpoint with development and debugging.

Example response
{
  "page_metadata": {
    "page": 1,
    "next": 2,
    "previous": 0,
    "hasNext": false,
    "hasPrevious": false,
    "total": 2,
    "limit": 10
  },
  "results": [
    {
      "agency_name": "Department of Health and Human Services",
      "abbreviation": "DHHS",
      "toptier_code": "020",
      "agency_id": 123,
      "current_total_budget_authority_amount": 8361447130497.72,
      "recent_publication_date": "2020-01-10T11:59:21Z",
      "recent_publication_date_certified": false,
      "tas_account_discrepancies_totals": {
        "gtas_obligation_total": 55234,
        "tas_accounts_total": 23923,
        "tas_obligation_not_in_gtas_total": 11543,
        "missing_tas_accounts_count": 20
      },
      "obligation_difference": 436376232652.87,
      "unlinked_contract_award_count": 3,
      "unlinked_assistance_award_count": 2,
      "assurance_statement_url": "https://files-nonprod.usaspending.gov/agency_submissions/Raw%20DATA%20Act%20Files/2020/P09/075%20-%20Department%20of%20Health%20and%20Human%20Services%20(HHS)/2020-P09-075_Department%20of%20Health%20and%20Human%20Services%20(HHS)-Assurance_Statement.txt"
    },
    {
      "agency_name": "Department of Treasury",
      "abbreviation": "DOT",
      "toptier_code": "021",
      "agency_id": 789,
      "current_total_budget_authority_amount": 8361447130497.72,
      "recent_publication_date": null,
      "recent_publication_date_certified": true,
      "tas_account_discrepancies_totals": {
        "gtas_obligation_total": 66432,
        "tas_accounts_total": 23913,
        "tas_obligation_not_in_gtas_total": 11543,
        "missing_tas_accounts_count": 10
      },
      "obligation_difference": 436376232652.87,
      "unlinked_contract_award_count": 0,
      "unlinked_assistance_award_count": 0,
      "assurance_statement_url": "https://files-nonprod.usaspending.gov/agency_submissions/Raw%20DATA%20Act%20Files/2020/P09/020%20-%20Department%20of%20the%20Treasury%20(TREAS)/2020-P09-020_Department%20of%20the%20Treasury%20(TREAS)-Assurance_Statement.txt"
    }
  ]
}

Recent changes

Generated from contracts/v2/reporting/agencies/overview.md in the USAspending API repo.

Loading…