USAspending API ReferenceIndependent
Try the API

Agency Reporting Differences

GET/api/v2/reporting/agencies/{toptier_code}/differences/
Powers Agency submission statistics on usaspending.gov

This endpoint is used to power USAspending.gov's About the Data | Agencies reported balance and spending differences over a submission period

This endpoint returns an overview of government agency obligation differences data.

Request

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

Path parameters

  • toptier_codestringRequired

    The specific agency code.

    Example 020

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

  • 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
    • difference
    • file_a_obligation
    • file_b_obligation
    • tas

    Default tas

Try it

Runs against the live API. Responses are real data.

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

Response · 200

  • page_metadataobject · PaginationMetadataRequired7 fields
    • pagenumberRequired
    • nextnumberRequiredNullable
    • previousnumberRequiredNullable
    • hasNextbooleanRequired
    • hasPreviousbooleanRequired
    • totalnumberRequired
    • limitnumberRequired
  • resultsarray of ObligationDifferencesRequired4 fields
    • tasstringRequired
    • file_a_obligationnumberRequired
    • file_b_obligationnumberRequired
    • differencenumberRequired
  • messagesarray of stringRequired

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

Example response
{
  "page_metadata": {
    "page": 1,
    "total": 10,
    "limit": 2,
    "next": 2,
    "previous": null,
    "hasNext": true,
    "hasPrevious": false
  },
  "results": [
    {
      "tas": "011-X-8345-000",
      "file_a_obligation": 47425.37,
      "file_b_obligation": 240066.32,
      "difference": -192640.95
    },
    {
      "tas": "011-X-8245-000",
      "file_a_obligation": 428508.11,
      "file_b_obligation": 2358478.83,
      "difference": -1929970.72
    }
  ],
  "messages": []
}

Recent changes

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

Loading…