USAspending API ReferenceIndependent
Try the API

Federal Obligations

GET/api/v2/agency/{toptier_code}/obligations_by_award_category/

This endpoint is used to power USAspending.gov's agency profile pages.

This endpoint returns a breakdown of obligations by award category (contracts, IDVs, grants, loans, direct payments, other) within the requested fiscal year (or current FY).

Request

curl 'https://api.usaspending.gov/api/v2/agency/086/obligations_by_award_category/'

Path parameters

  • toptier_codestringRequired

    The toptier code of an agency (could be a CGAC or FREC) so only numeric character strings of length 3-4 are accepted.

    Example 086

Query parameters

  • fiscal_yearstring

    The fiscal year for which you are querying data. Defaults to the current fiscal year if not provided.

    Example 2017

Try it

Runs against the live API. Responses are real data.

GET/api/v2/agency/086/obligations_by_award_category/?fiscal_year=2017

Response · 200

  • total_aggregated_amountnumberRequired

    The agency's total award obligations for the provided fiscal year

  • resultsarray of ObligationSubtotalsRequired2 fields

    Sorted by aggregated_amount, descending. Categories with $0 of obligations within the FY are not included.

    • categoryenum (string)Required
      Allowed values
      • contracts
      • direct_payments
      • idvs
      • grants
      • loans
      • other
    • aggregated_amountnumberRequired
Example response
{
  "total_aggregated_amount": 1219.55,
  "results": [
    {
      "category": "contracts",
      "aggregated_amount": 1000
    },
    {
      "category": "direct_payments",
      "aggregated_amount": 60.55
    },
    {
      "category": "idvs",
      "aggregated_amount": 55
    },
    {
      "category": "grants",
      "aggregated_amount": 100
    },
    {
      "category": "loans",
      "aggregated_amount": 0
    },
    {
      "category": "other",
      "aggregated_amount": 4
    }
  ]
}

Recent changes

Generated from contracts/v2/agency/toptier_code/obligations_by_award_category.md in the USAspending API repo.

Loading…