Agency Reporting Overview

GET/api/v2/reporting/agencies/{toptier_code}/overview/

Powers Agency submission statistics on usaspending.gov

This endpoint is used to power USAspending.gov's About the Data | Agencies agency details table.

This endpoint returns an overview of government agency submission data.

Request

curl 'https://api.usaspending.gov/api/v2/reporting/agencies/020/overview/'

Path parameters

toptier_codestringRequired
The specific agency's toptier code.
Example 020

Query parameters

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
- current_total_budget_authority_amount
- fiscal_period
- fiscal_year
- missing_tas_accounts_count
- tas_accounts_total
- obligation_difference
- percent_of_total_budgetary_resources
- 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/020/overview/

toptier_code path, required

page query

limit query

order query

sort query

Response · 200

page_metadataobject · PaginationMetadataRequired7 fields
- pagenumberRequired
- nextnumberRequiredNullable
- previousnumberRequiredNullable
- hasNextbooleanRequired
- hasPreviousbooleanRequired
- totalnumberRequired
- limitnumberRequired
resultsarray of AgencyDataRequired12 fields
- fiscal_yearnumberRequired
- fiscal_periodnumberRequired
- current_total_budget_authority_amountnumberRequiredNullable
- total_budgetary_resourcesnumberRequiredNullable
- percent_of_total_budgetary_resourcesnumberRequiredNullable
- 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

{
  "messages": [],
  "page_metadata": {
    "page": 1,
    "next": 2,
    "previous": 0,
    "hasNext": false,
    "hasPrevious": false,
    "total": 2,
    "limit": 10
  },
  "results": [
    {
      "fiscal_year": 2020,
      "fiscal_period": 7,
      "current_total_budget_authority_amount": 192340342676.75,
      "total_budgetary_resources": 13105812389531.01,
      "percent_of_total_budgetary_resources": 1.47,
      "recent_publication_date": "2020-08-13T13:40:21.181994Z",
      "recent_publication_date_certified": true,
      "tas_account_discrepancies_totals": {
        "gtas_obligation_total": 62668762422.57,
        "tas_accounts_total": 62659366681.07,
        "tas_obligation_not_in_gtas_total": 9395741.5,
        "missing_tas_accounts_count": 9
      },
      "obligation_difference": 12581114.45,
      "unlinked_contract_award_count": 2,
      "unlinked_assistance_award_count": 5,
      "assurance_statement_url": "https://files.usaspending.gov/agency_submissions/Raw%20DATA%20Act%20Files/2020/P07/020%20-%20Department%20of%20the%20Treasury%20(TREAS)/2020-P07-020_Department%20of%20the%20Treasury%20(TREAS)-Assurance_Statement.txt"
    },
    {
      "fiscal_year": 2020,
      "fiscal_period": 6,
      "current_total_budget_authority_amount": 192243648186.87,
      "total_budgetary_resources": 10127796351165.57,
      "percent_of_total_budgetary_resources": 1.9,
      "recent_publication_date": "2020-05-14T13:08:23.624634Z",
      "recent_publication_date_certified": true,
      "tas_account_discrepancies_totals": {
        "gtas_obligation_total": 42417596510.72,
        "tas_accounts_total": 42417271495.34,
        "tas_obligation_not_in_gtas_total": 325015.38,
        "missing_tas_accounts_count": 2
      },
      "obligation_difference": 14702670.23,
      "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/Q2/020%20-%20Department%20of%20the%20Treasury%20(TREAS)/2020-Q2-020_Department%20of%20the%20Treasury%20(TREAS)-Assurance_Statement.txt"
    }
  ]
}

Recent changes

May 4, 2021Mentioned in the May 4, 2021 release notes
March 10, 2021Mentioned in the March 10, 2021 release notes
February 22, 2021Mentioned in the February 22, 2021 release notes

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